directus-template-cli 0.7.6 → 0.8.0-partials.0

package/dist/lib/template-plan/index.js

@@ -0,0 +1,77 @@
+import catchError from '../utils/catch-error.js';
+import { componentNames } from './flags.js';
+function parseList(value) {
+    if (!value)
+        return undefined;
+    const raw = Array.isArray(value) ? value.join(',') : value;
+    const values = raw
+        .split(',')
+        .map((item) => item.trim())
+        .filter(Boolean);
+    return values.length > 0 ? values : undefined;
+}
+function hasPartialOnlyFlags(flags) {
+    return Boolean(flags.collections ||
+        flags.excludeCollections ||
+        flags.noAssets === true ||
+        flags.relationStrategy !== undefined ||
+        flags.allowBrokenRelations === true);
+}
+function hasScopingFlags(flags) {
+    return Boolean(flags.collections || flags.excludeCollections || flags.noAssets === true || hasComponentFlags(flags));
+}
+function hasComponentFlags(flags) {
+    return componentNames.some((component) => flags[component] !== undefined);
+}
+function buildComponents(flags, partial) {
+    const components = {};
+    const enabled = componentNames.filter((component) => flags[component] === true);
+    const disabled = componentNames.filter((component) => flags[component] === false);
+    if (!partial) {
+        for (const component of componentNames)
+            components[component] = true;
+        return components;
+    }
+    if (enabled.length > 0) {
+        for (const component of componentNames)
+            components[component] = enabled.includes(component);
+    }
+    else if (disabled.length > 0) {
+        for (const component of componentNames)
+            components[component] = !disabled.includes(component);
+    }
+    else {
+        for (const component of componentNames)
+            components[component] = true;
+    }
+    if (flags.noAssets)
+        components.files = false;
+    return components;
+}
+export function buildTemplatePlan(flags = {}) {
+    const collections = parseList(flags.collections);
+    const excludeCollections = parseList(flags.excludeCollections) || (flags.noAssets ? [] : undefined);
+    if (flags.noAssets && !excludeCollections?.includes('directus_files')) {
+        excludeCollections?.push('directus_files');
+    }
+    const partial = Boolean(flags.partial || hasComponentFlags(flags) || hasPartialOnlyFlags(flags));
+    const components = buildComponents(flags, partial);
+    if (!componentNames.some((component) => components[component])) {
+        catchError(new Error('At least one template component must be enabled.'), { fatal: true });
+    }
+    return {
+        allowBrokenRelations: Boolean(flags.allowBrokenRelations),
+        collections,
+        components,
+        excludeCollections,
+        partial,
+        relationStrategy: (flags.relationStrategy ||
+            (partial ? (hasScopingFlags(flags) ? 'empty' : 'preserve') : 'deep')),
+    };
+}
+export * from './collections.js';
+export * from './flags.js';
+export * from './junctions.js';
+export * from './metadata-plan.js';
+export * from './metadata.js';
+export * from './types.js';

package/dist/lib/template-plan/junctions.d.ts

@@ -0,0 +1,10 @@
+import type { TemplatePlan } from './types.js';
+interface JunctionRelation {
+    collection: string;
+    meta?: {
+        junction_field?: null | string;
+    };
+    related_collection?: null | string;
+}
+export declare function getBrokenJunctionCollections(relations: JunctionRelation[], plan?: TemplatePlan): Set<string>;
+export {};

package/dist/lib/template-plan/junctions.js

@@ -0,0 +1,19 @@
+import { includesCollection } from './collections.js';
+// Directus sets meta.junction_field on both FK legs of an M2M to point to the other FK.
+// Any collection appearing as `collection` on such a relation is a junction table.
+// System collections (directus_*) always exist on every instance — never treat them as broken FK targets.
+export function getBrokenJunctionCollections(relations, plan) {
+    if (!plan?.partial)
+        return new Set();
+    const junctionCollections = new Set(relations.filter((r) => r.meta?.junction_field).map((r) => r.collection));
+    const broken = new Set();
+    for (const junction of junctionCollections) {
+        const targets = relations
+            .filter((r) => r.collection === junction && r.related_collection)
+            .map((r) => r.related_collection);
+        if (targets.some((target) => !target.startsWith('directus_') && !includesCollection(target, plan))) {
+            broken.add(junction);
+        }
+    }
+    return broken;
+}

package/dist/lib/template-plan/metadata-plan.d.ts

@@ -0,0 +1,2 @@
+import type { TemplateMetadata, TemplatePlan } from './types.js';
+export declare function applyMetadataToPlan(plan: TemplatePlan, metadata?: TemplateMetadata): TemplatePlan;

package/dist/lib/template-plan/metadata-plan.js

@@ -0,0 +1,33 @@
+import catchError from '../utils/catch-error.js';
+import { componentNames } from './flags.js';
+function intersectCollections(scope, requested, available) {
+    if (requested && available) {
+        const collections = requested.filter((collection) => available.includes(collection));
+        if (collections.length === 0) {
+            catchError(new Error(`No requested ${scope} match this template`), { fatal: true });
+        }
+        return collections;
+    }
+    return requested || available;
+}
+function mergeExcludedCollections(requested, available) {
+    const values = [...(requested || []), ...(available || [])];
+    return values.length > 0 ? [...new Set(values)] : undefined;
+}
+export function applyMetadataToPlan(plan, metadata) {
+    if (!metadata)
+        return plan;
+    const components = { ...plan.components };
+    for (const component of componentNames) {
+        components[component] = components[component] && metadata.components[component];
+    }
+    const partial = metadata.partial || componentNames.some((component) => components[component] !== plan.components[component]);
+    return {
+        ...plan,
+        collections: intersectCollections('collections', plan.collections, metadata.collections),
+        components,
+        excludeCollections: mergeExcludedCollections(plan.excludeCollections, metadata.excludedCollections),
+        partial,
+        schemaCollections: intersectCollections('schema collections', plan.schemaCollections, metadata.schemaCollections),
+    };
+}

package/dist/lib/template-plan/metadata.d.ts

@@ -0,0 +1,5 @@
+import type { TemplateMetadata, TemplatePlan, TemplateWarning } from './types.js';
+export declare function createTemplateMetadata(plan: TemplatePlan, warnings?: TemplateWarning[]): TemplateMetadata;
+export declare function getTemplateMetadataPath(dir: string): string;
+export declare function readTemplateMetadata(dir: string): TemplateMetadata | undefined;
+export declare function writeTemplateMetadata(dir: string, plan: TemplatePlan, warnings?: TemplateWarning[]): Promise<void>;

package/dist/lib/template-plan/metadata.js

@@ -0,0 +1,39 @@
+import fs from 'node:fs';
+import path from 'pathe';
+import catchError from '../utils/catch-error.js';
+const META_FILE = 'template-meta.json';
+export function createTemplateMetadata(plan, warnings = []) {
+    return {
+        allowBrokenRelations: plan.allowBrokenRelations,
+        collections: plan.collections,
+        components: plan.components,
+        excludedCollections: plan.excludeCollections,
+        partial: plan.partial,
+        relationStrategy: plan.relationStrategy,
+        schemaCollections: plan.schemaCollections,
+        version: 2,
+        warnings,
+    };
+}
+export function getTemplateMetadataPath(dir) {
+    return path.join(dir, META_FILE);
+}
+export function readTemplateMetadata(dir) {
+    const filePath = getTemplateMetadataPath(dir);
+    if (!fs.existsSync(filePath))
+        return undefined;
+    try {
+        const metadata = JSON.parse(fs.readFileSync(filePath, 'utf8'));
+        if (metadata.version !== 2) {
+            catchError(new Error(`Unsupported template metadata version: ${metadata.version}`), { fatal: true });
+        }
+        return metadata;
+    }
+    catch (error) {
+        catchError(error, { fatal: true });
+    }
+}
+export async function writeTemplateMetadata(dir, plan, warnings = []) {
+    const filePath = getTemplateMetadataPath(dir);
+    await fs.promises.writeFile(filePath, JSON.stringify(createTemplateMetadata(plan, warnings), null, 2));
+}

package/dist/lib/template-plan/types.d.ts

@@ -0,0 +1,34 @@
+export type RelationStrategy = 'deep' | 'empty' | 'preserve';
+export interface TemplateComponents {
+    content: boolean;
+    dashboards: boolean;
+    extensions: boolean;
+    files: boolean;
+    flows: boolean;
+    permissions: boolean;
+    schema: boolean;
+    settings: boolean;
+    users: boolean;
+}
+export interface TemplatePlan {
+    allowBrokenRelations: boolean;
+    collections?: string[];
+    components: TemplateComponents;
+    excludeCollections?: string[];
+    partial: boolean;
+    relationStrategy: RelationStrategy;
+    schemaCollections?: string[];
+}
+export type TemplateWarning = {
+    collection: string;
+    count: number;
+    field: string;
+    relatedCollection: string;
+    type: 'excluded_relation';
+};
+export interface TemplateMetadata extends Omit<TemplatePlan, 'excludeCollections'> {
+    excludedCollections?: string[];
+    version: 2;
+    warnings: TemplateWarning[];
+}
+export type TemplateComponent = keyof TemplateComponents;

package/dist/lib/template-plan/types.js

@@ -0,0 +1 @@
+export {};

package/dist/services/github.js

@@ -114,7 +114,7 @@ export function createGitHub(token) {
         });
         if (!Array.isArray(rootContent))
             return [];
-        const directories = rootContent.filter(item => item.type === 'dir');
+        const directories = rootContent.filter(item => item.type === 'dir' && !item.name.startsWith('.') && !item.name.startsWith('_'));
         // Fetch package.json for each directory concurrently
         const templateInfos = await Promise.all(directories.map(async (dir) => {
             const packageJsonPath = joinPath(repo.path || '', dir.path, 'package.json');

package/oclif.manifest.json

@@ -10,14 +10,30 @@
         "$ directus-template-cli@beta apply -p --directusUrl=\"http://localhost:8055\" --directusToken=\"admin-token-here\" --templateLocation=\"./my-template\" --templateType=\"local\" --partial --no-content --no-users"
       ],
       "flags": {
+        "allowBrokenRelations": {
+          "aliases": [
+            "allow-broken-relations"
+          ],
+          "description": "Allow intentionally incomplete relation references",
+          "name": "allowBrokenRelations",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "collections": {
+          "description": "Only include these comma-separated collections",
+          "name": "collections",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "content": {
-          "description": "Load Content (data)",
+          "description": "Include content/data",
           "name": "content",
           "allowNo": true,
           "type": "boolean"
         },
         "dashboards": {
-          "description": "Load Dashboards (dashboards, panels)",
+          "description": "Include dashboards and panels",
           "name": "dashboards",
           "allowNo": true,
           "type": "boolean"
@@ -49,24 +65,43 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "excludeCollections": {
+          "aliases": [
+            "exclude-collections"
+          ],
+          "description": "Exclude these comma-separated collections",
+          "name": "excludeCollections",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "extensions": {
-          "description": "Load Extensions",
+          "description": "Include extensions",
           "name": "extensions",
           "allowNo": true,
           "type": "boolean"
         },
         "files": {
-          "description": "Load Files (files, folders)",
+          "description": "Include files, folders, and assets",
           "name": "files",
           "allowNo": true,
           "type": "boolean"
         },
         "flows": {
-          "description": "Load Flows (operations, flows)",
+          "description": "Include flows and operations",
           "name": "flows",
           "allowNo": true,
           "type": "boolean"
         },
+        "noAssets": {
+          "aliases": [
+            "no-assets"
+          ],
+          "description": "Shorthand for --no-files and --exclude-collections directus_files",
+          "name": "noAssets",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "noExit": {
           "hidden": true,
           "name": "noExit",
@@ -74,19 +109,15 @@
           "type": "boolean"
         },
         "partial": {
-          "dependsOn": [
-            "programmatic"
-          ],
-          "description": "Enable partial template application (all components enabled by default)",
+          "description": "Enable partial template mode",
           "name": "partial",
-          "summary": "Enable partial template application",
+          "summary": "Enable partial template mode",
           "allowNo": false,
           "type": "boolean"
         },
         "permissions": {
-          "description": "Loads permissions data. Collections include: directus_roles, directus_policies, directus_access, directus_permissions.",
+          "description": "Include permissions, roles, policies, and access",
           "name": "permissions",
-          "summary": "Load permissions (roles, policies, access, permissions)",
           "allowNo": true,
           "type": "boolean"
         },
@@ -98,14 +129,29 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "relationStrategy": {
+          "aliases": [
+            "relation-strategy"
+          ],
+          "description": "How to handle relations to omitted data",
+          "name": "relationStrategy",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "empty",
+            "preserve",
+            "deep"
+          ],
+          "type": "option"
+        },
         "schema": {
-          "description": "Load schema (collections, relations)",
+          "description": "Include schema, collections, fields, and relations",
           "name": "schema",
           "allowNo": true,
           "type": "boolean"
         },
         "settings": {
-          "description": "Load settings (project settings, translations, presets)",
+          "description": "Include settings, translations, and presets",
           "name": "settings",
           "allowNo": true,
           "type": "boolean"
@@ -168,7 +214,7 @@
           "type": "option"
         },
         "users": {
-          "description": "Load users",
+          "description": "Include users",
           "name": "users",
           "allowNo": true,
           "type": "boolean"
@@ -244,6 +290,13 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "partial": {
+          "description": "Enable partial template mode",
+          "name": "partial",
+          "summary": "Enable partial template mode",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "programmatic": {
           "char": "p",
           "description": "Run in programmatic mode (non-interactive) for use cases such as CI/CD pipelines.",
@@ -301,6 +354,110 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "content": {
+          "description": "Include content/data",
+          "name": "content",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "dashboards": {
+          "description": "Include dashboards and panels",
+          "name": "dashboards",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "extensions": {
+          "description": "Include extensions",
+          "name": "extensions",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "files": {
+          "description": "Include files, folders, and assets",
+          "name": "files",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "flows": {
+          "description": "Include flows and operations",
+          "name": "flows",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "permissions": {
+          "description": "Include permissions, roles, policies, and access",
+          "name": "permissions",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "schema": {
+          "description": "Include schema, collections, fields, and relations",
+          "name": "schema",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "settings": {
+          "description": "Include settings, translations, and presets",
+          "name": "settings",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "users": {
+          "description": "Include users",
+          "name": "users",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "allowBrokenRelations": {
+          "aliases": [
+            "allow-broken-relations"
+          ],
+          "description": "Allow intentionally incomplete relation references",
+          "name": "allowBrokenRelations",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "collections": {
+          "description": "Only include these comma-separated collections",
+          "name": "collections",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "excludeCollections": {
+          "aliases": [
+            "exclude-collections"
+          ],
+          "description": "Exclude these comma-separated collections",
+          "name": "excludeCollections",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "noAssets": {
+          "aliases": [
+            "no-assets"
+          ],
+          "description": "Shorthand for --no-files and --exclude-collections directus_files",
+          "name": "noAssets",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "relationStrategy": {
+          "aliases": [
+            "relation-strategy"
+          ],
+          "description": "How to handle relations to omitted data",
+          "name": "relationStrategy",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "empty",
+            "preserve",
+            "deep"
+          ],
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -401,5 +558,5 @@
       ]
     }
   },
-  "version": "0.7.6"
+  "version": "0.8.0-partials.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directus-template-cli",
-  "version": "0.7.6",
+  "version": "0.8.0-partials.0",
   "description": "CLI Utility for applying templates to a Directus instance.",
   "author": "bryantgillespie @bryantgillespie",
   "type": "module",
@@ -32,7 +32,6 @@
     "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",

package/dist/lib/load/update-required-fields.d.ts

@@ -1 +0,0 @@
-export default function updateRequiredFields(dir: string): Promise<void>;

package/dist/lib/load/update-required-fields.js

@@ -1,20 +0,0 @@
-import { updateField } from '@directus/sdk';
-import { ux } from '@oclif/core';
-import { DIRECTUS_PINK } from '../constants.js';
-import { api } from '../sdk.js';
-import catchError from '../utils/catch-error.js';
-import readFile from '../utils/read-file.js';
-export default async function updateRequiredFields(dir) {
-    const fieldsToUpdate = readFile('fields', dir)
-        .filter(field => field.meta.required === true || field.schema?.is_nullable === false || field.schema?.is_unique === true);
-    ux.action.start(ux.colorize(DIRECTUS_PINK, `Updating ${fieldsToUpdate.length} fields to required`));
-    for await (const field of fieldsToUpdate) {
-        try {
-            await api.client.request(updateField(field.collection, field.field, { meta: { ...field.meta }, schema: { ...field.schema } }));
-        }
-        catch (error) {
-            catchError(error);
-        }
-    }
-    ux.action.stop();
-}