nuxt-directus-sdk 4.0.4 → 5.0.0-beta.1

package/dist/cli/index.d.mts

@@ -0,0 +1 @@
+

package/dist/cli/index.d.ts

@@ -0,0 +1 @@
+

package/dist/cli/index.mjs

@@ -0,0 +1,298 @@
+#!/usr/bin/env node
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { parseArgs } from 'node:util';
+import { createDirectus, staticToken, rest } from '@directus/sdk';
+import { g as diffRemoteRules, m as formatDiff, f as compareRulesPayloads, j as fetchRemoteRules, b as loadRulesFromPayload, q as pushRules, o as formatPushResult, k as fetchRemoteRulesAsJson } from '../shared/nuxt-directus-sdk.BpCtdNcG.mjs';
+
+function loadEnv() {
+  const envPath = resolve(process.cwd(), ".env");
+  if (existsSync(envPath)) {
+    const content = readFileSync(envPath, "utf-8");
+    for (const line of content.split("\n")) {
+      const trimmed = line.trim();
+      if (!trimmed || trimmed.startsWith("#"))
+        continue;
+      const [key, ...valueParts] = trimmed.split("=");
+      if (key && valueParts.length > 0) {
+        const value = valueParts.join("=").replace(/^["']|["']$/g, "");
+        if (!process.env[key]) {
+          process.env[key] = value;
+        }
+      }
+    }
+  }
+}
+function getConnectionConfig(urlFlag, tokenFlag, label) {
+  const url = urlFlag ?? process.env.DIRECTUS_URL;
+  const token = tokenFlag ?? process.env.DIRECTUS_ADMIN_TOKEN;
+  if (!url) {
+    console.error(`Error: ${label} URL is required`);
+    console.error(`Provide --${label.toLowerCase()}-url or set DIRECTUS_URL in your .env file`);
+    process.exit(1);
+  }
+  if (!token) {
+    console.error(`Error: ${label} token is required`);
+    console.error(`Provide --${label.toLowerCase()}-token or set DIRECTUS_ADMIN_TOKEN in your .env file`);
+    process.exit(1);
+  }
+  return { url, token };
+}
+function createClient(url, token) {
+  return createDirectus(url).with(staticToken(token)).with(rest());
+}
+function printHelp() {
+  console.log(`
+Directus Rules CLI
+
+Usage:
+  npx nuxt-directus-sdk <command> [options]
+
+Commands:
+  rules:pull                Download rules from Directus and save as JSON
+  rules:push <file>         Push local JSON rules to remote Directus
+  rules:diff <file>         Compare local JSON file with remote Directus
+  rules:diff-files <a> <b>  Compare two local JSON files
+  rules:diff-remote         Compare two remote Directus instances
+
+Options:
+  -h, --help                Show this help message
+  -o, --output <file>       Output file path (default: rules.json)
+  --compact                 Output compact JSON (no pretty-print)
+  --dry-run                 Show what would be changed without making changes (rules:push)
+  --add-only                Only add new items, don't modify or delete existing (rules:push)
+  --skip-deletes            Skip deleting items that exist remotely but not locally (rules:push)
+
+  Connection options (override DIRECTUS_URL / DIRECTUS_ADMIN_TOKEN):
+  --source-url <url>        Source Directus URL
+  --source-token <token>    Source admin token
+  --target-url <url>        Target Directus URL (for rules:diff-remote)
+  --target-token <token>    Target admin token (for rules:diff-remote)
+
+Environment Variables:
+  DIRECTUS_URL              Default Directus URL (used if --source-url not provided)
+  DIRECTUS_ADMIN_TOKEN      Default admin token (used if --source-token not provided)
+
+Examples:
+  # Pull rules from Directus (uses env vars)
+  npx nuxt-directus-sdk rules:pull
+
+  # Pull from a specific instance
+  npx nuxt-directus-sdk rules:pull --source-url https://my-directus.com --source-token my-token
+
+  # Preview what would be pushed (dry run)
+  npx nuxt-directus-sdk rules:push rules.json --dry-run
+
+  # Push rules to Directus
+  npx nuxt-directus-sdk rules:push rules.json
+
+  # Push only new items (safe mode)
+  npx nuxt-directus-sdk rules:push rules.json --add-only
+
+  # Compare local file with remote
+  npx nuxt-directus-sdk rules:diff rules.json
+
+  # Compare two local JSON files
+  npx nuxt-directus-sdk rules:diff-files staging.json production.json
+
+  # Compare two remote instances
+  npx nuxt-directus-sdk rules:diff-remote \\
+    --source-url https://staging.example.com --source-token staging-token \\
+    --target-url https://production.example.com --target-token production-token
+`);
+}
+function loadJsonFile(filePath) {
+  if (!existsSync(filePath)) {
+    console.error(`Error: File not found: ${filePath}`);
+    process.exit(1);
+  }
+  const content = readFileSync(filePath, "utf-8");
+  try {
+    return JSON.parse(content);
+  } catch {
+    console.error(`Error: Invalid JSON in ${filePath}`);
+    process.exit(1);
+  }
+}
+async function commandPull(options, connection) {
+  const client = createClient(connection.url, connection.token);
+  console.log(`Fetching rules from ${connection.url}...`);
+  const json = await fetchRemoteRulesAsJson(client, !options.compact);
+  writeFileSync(options.output, json);
+  console.log(`Rules saved to ${options.output}`);
+  const rules = JSON.parse(json);
+  console.log(`  ${rules.roles.length} roles`);
+  console.log(`  ${rules.policies.length} policies`);
+  console.log(`  ${rules.permissions.length} permissions`);
+}
+async function commandDiff(localFile, connection) {
+  const local = loadJsonFile(localFile);
+  console.log(`Comparing ${localFile} with ${connection.url}...`);
+  const client = createClient(connection.url, connection.token);
+  const remote = await fetchRemoteRules(client);
+  const diff = compareRulesPayloads(local, remote);
+  console.log();
+  console.log(formatDiff(diff));
+  if (diff.hasChanges) {
+    process.exit(1);
+  }
+}
+async function commandDiffFiles(fileA, fileB) {
+  console.log(`Comparing ${fileA} with ${fileB}...`);
+  const rulesA = loadJsonFile(fileA);
+  const rulesB = loadJsonFile(fileB);
+  const diff = compareRulesPayloads(rulesA, rulesB);
+  console.log();
+  console.log(formatDiff(diff));
+  if (diff.hasChanges) {
+    process.exit(1);
+  }
+}
+async function commandDiffRemote(source, target) {
+  console.log(`Comparing ${source.url} with ${target.url}...`);
+  const sourceClient = createClient(source.url, source.token);
+  const targetClient = createClient(target.url, target.token);
+  const diff = await diffRemoteRules(sourceClient, targetClient);
+  console.log();
+  console.log(formatDiff(diff));
+  if (diff.hasChanges) {
+    process.exit(1);
+  }
+}
+async function commandPush(localFile, connection, options) {
+  const payload = loadJsonFile(localFile);
+  const rules = loadRulesFromPayload(payload);
+  const client = createClient(connection.url, connection.token);
+  if (options.dryRun) {
+    console.log(`Dry run: comparing ${localFile} with ${connection.url}...`);
+    const remote = await fetchRemoteRules(client);
+    const diff = compareRulesPayloads(payload, remote);
+    console.log();
+    console.log(formatDiff(diff));
+    if (!diff.hasChanges) {
+      console.log("\nNo changes to push.");
+    } else {
+      console.log("\nRun without --dry-run to apply these changes.");
+    }
+    return;
+  }
+  console.log(`Pushing rules from ${localFile} to ${connection.url}...`);
+  const result = await pushRules(client, rules, {
+    addOnly: options.addOnly,
+    skipDeletes: options.skipDeletes,
+    onProgress: (event) => {
+      const action = event.action === "create" ? "+" : event.action === "update" ? "~" : "-";
+      console.log(`  [${event.current}/${event.total}] ${action} ${event.phase}: ${event.name}`);
+    }
+  });
+  console.log();
+  console.log(formatPushResult(result));
+  if (!result.success) {
+    process.exit(1);
+  }
+}
+async function main() {
+  loadEnv();
+  const { values, positionals } = parseArgs({
+    allowPositionals: true,
+    options: {
+      "help": { type: "boolean", short: "h" },
+      "output": { type: "string", short: "o", default: "rules.json" },
+      "compact": { type: "boolean", default: false },
+      "dry-run": { type: "boolean", default: false },
+      "add-only": { type: "boolean", default: false },
+      "skip-deletes": { type: "boolean", default: false },
+      "source-url": { type: "string" },
+      "source-token": { type: "string" },
+      "target-url": { type: "string" },
+      "target-token": { type: "string" }
+    }
+  });
+  if (values.help || positionals.length === 0) {
+    printHelp();
+    process.exit(0);
+  }
+  const command = positionals[0];
+  try {
+    switch (command) {
+      case "rules:pull": {
+        const connection = getConnectionConfig(
+          values["source-url"],
+          values["source-token"],
+          "Source"
+        );
+        await commandPull({
+          output: values.output,
+          compact: values.compact
+        }, connection);
+        break;
+      }
+      case "rules:push": {
+        if (!positionals[1]) {
+          console.error("Error: rules:push requires a file path");
+          console.error("Usage: npx nuxt-directus-sdk rules:push <file> [--dry-run]");
+          process.exit(1);
+        }
+        const connection = getConnectionConfig(
+          values["source-url"],
+          values["source-token"],
+          "Source"
+        );
+        await commandPush(positionals[1], connection, {
+          dryRun: values["dry-run"],
+          addOnly: values["add-only"],
+          skipDeletes: values["skip-deletes"]
+        });
+        break;
+      }
+      case "rules:diff": {
+        if (!positionals[1]) {
+          console.error("Error: rules:diff requires a file path");
+          console.error("Usage: npx nuxt-directus-sdk rules:diff <file>");
+          process.exit(1);
+        }
+        const connection = getConnectionConfig(
+          values["source-url"],
+          values["source-token"],
+          "Source"
+        );
+        await commandDiff(positionals[1], connection);
+        break;
+      }
+      case "rules:diff-files":
+        if (!positionals[1] || !positionals[2]) {
+          console.error("Error: rules:diff-files requires two file paths");
+          console.error("Usage: npx nuxt-directus-sdk rules:diff-files <file-a> <file-b>");
+          process.exit(1);
+        }
+        await commandDiffFiles(positionals[1], positionals[2]);
+        break;
+      case "rules:diff-remote": {
+        const source = getConnectionConfig(
+          values["source-url"],
+          values["source-token"],
+          "Source"
+        );
+        const target = getConnectionConfig(
+          values["target-url"],
+          values["target-token"],
+          "Target"
+        );
+        await commandDiffRemote(source, target);
+        break;
+      }
+      default:
+        console.error(`Unknown command: ${command}`);
+        printHelp();
+        process.exit(1);
+    }
+  } catch (error) {
+    if (error instanceof Error) {
+      console.error(`Error: ${error.message}`);
+    } else {
+      console.error("An unknown error occurred");
+    }
+    process.exit(1);
+  }
+}
+main();

package/dist/module.d.mts

@@ -1,5 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { Query } from '@directus/sdk';
+import { ImageProviders, ImageModifiers } from '@nuxt/image';
 
 interface ModuleOptions {
     /**
@@ -12,8 +13,8 @@ interface ModuleOptions {
      * Development proxy configuration
      * When enabled, creates a proxy at /directus that forwards to your Directus URL
      * This solves CORS and cookie issues in development
-     * @default { enabled: true, path: '/directus' } in dev mode
-     * @type boolean | { enabled?: boolean, path?: string }
+     * @default { enabled: true, path: '/directus', wsPath: '/directus-ws' } in dev mode
+     * @type boolean | { enabled?: boolean, path?: string, wsPath?: string }
      */
     devProxy?: boolean | {
         /**
@@ -26,6 +27,11 @@ interface ModuleOptions {
          * @default '/directus'
          */
         path?: string;
+        /**
+         * WebSocket proxy path (for realtime connections)
+         * @default '/directus-ws'
+         */
+        wsPath?: string;
     };
     /**
      * Admin Auth Token used for generating types and server functions
@@ -35,16 +41,38 @@ interface ModuleOptions {
     adminToken?: string;
     /**
      * Add Directus Admin in Nuxt Devtools
-     *
      * @default true
      */
     devtools?: boolean;
     /**
      * Add Directus Visual Editor capabilities
-     *
      * @default true
      */
     visualEditor?: boolean;
+    /**
+     * @nuxt/image integration
+     * @default true
+     */
+    image?: boolean | {
+        /**
+         * Enable @nuxt/image integration
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * Set Directus as the default provider for NuxtImg
+         * @default false
+         */
+        setDefaultProvider?: boolean;
+        /**
+         * Custom Directus provider configuration
+         */
+        directus?: ImageProviders['directus'];
+        /**
+         * Default modifiers for Directus provider
+         */
+        modifiers?: ImageModifiers;
+    };
     /**
      * Auth options
      */
@@ -53,7 +81,6 @@ interface ModuleOptions {
          * Enable auth middleware
          * @default true
          * @type boolean
-         *
          */
         enabled?: boolean;
         /**
@@ -90,30 +117,30 @@ interface ModuleOptions {
         redirect?: {
             /**
              * Redirect to home page after login
-             * @default '/home'
+             * @default '/'
              */
             home?: string;
             /**
-             * Redirect to login page after logout
+             * Redirect to login when using auth middleware
              * @default '/auth/login'
              */
             login?: string;
             /**
-             * Redirect to login page after logout
-             * @default '/auth/login'
+             * Redirect to home page page after logout
+             * @default '/'
              */
             logout?: string;
         };
     };
-    types?: {
+    types?: boolean | {
         /**
-         * Generate types for your Directus instance
+         * Enable type generation
          * @type boolean
          * @default true
          */
         enabled?: boolean;
         /**
-         * The prefix to your custom types
+         * Prefix for custom collection types (does not affect DirectusSchema keys)
          * @type string
          * @default ''
          */

package/dist/module.d.ts

@@ -0,0 +1,166 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { Query } from '@directus/sdk';
+import { ImageProviders, ImageModifiers } from '@nuxt/image';
+
+interface ModuleOptions {
+    /**
+     * Directus API URL
+     * @default process.env.DIRECTUS_URL
+     * @type string
+     */
+    url: string;
+    /**
+     * Development proxy configuration
+     * When enabled, creates a proxy at /directus that forwards to your Directus URL
+     * This solves CORS and cookie issues in development
+     * @default { enabled: true, path: '/directus', wsPath: '/directus-ws' } in dev mode
+     * @type boolean | { enabled?: boolean, path?: string, wsPath?: string }
+     */
+    devProxy?: boolean | {
+        /**
+         * Enable the development proxy
+         * @default true in dev mode, false in production
+         */
+        enabled?: boolean;
+        /**
+         * Proxy path (where the proxy will be mounted)
+         * @default '/directus'
+         */
+        path?: string;
+        /**
+         * WebSocket proxy path (for realtime connections)
+         * @default '/directus-ws'
+         */
+        wsPath?: string;
+    };
+    /**
+     * Admin Auth Token used for generating types and server functions
+     * @default process.env.DIRECTUS_ADMIN_TOKEN
+     * @type string
+     */
+    adminToken?: string;
+    /**
+     * Add Directus Admin in Nuxt Devtools
+     * @default true
+     */
+    devtools?: boolean;
+    /**
+     * Add Directus Visual Editor capabilities
+     * @default true
+     */
+    visualEditor?: boolean;
+    /**
+     * @nuxt/image integration
+     * @default true
+     */
+    image?: boolean | {
+        /**
+         * Enable @nuxt/image integration
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * Set Directus as the default provider for NuxtImg
+         * @default false
+         */
+        setDefaultProvider?: boolean;
+        /**
+         * Custom Directus provider configuration
+         */
+        directus?: ImageProviders['directus'];
+        /**
+         * Default modifiers for Directus provider
+         */
+        modifiers?: ImageModifiers;
+    };
+    /**
+     * Auth options
+     */
+    auth?: {
+        /**
+         * Enable auth middleware
+         * @default true
+         * @type boolean
+         */
+        enabled?: boolean;
+        /**
+         * Enable global auth middleware
+         * @default false
+         * @type boolean
+         */
+        enableGlobalAuthMiddleware?: boolean;
+        /**
+         * Auto refresh tokens
+         * @default true
+         * @type boolean
+         */
+        autoRefresh?: boolean;
+        /**
+         * Credentials mode for cross-domain requests
+         * Set to 'include' when your frontend and backend are on different domains
+         * @default 'include'
+         * @type RequestCredentials
+         */
+        credentials?: RequestCredentials;
+        /**
+         * Realtime/WebSocket authentication mode
+         * @default 'handshake'
+         * @type 'public' | 'handshake' | 'strict'
+         */
+        realtimeAuthMode?: 'public' | 'handshake' | 'strict';
+        /**
+         * ReadMe fields to fetch
+         * @default []
+         * @type Query<DirectusSchema, DirectusSchema['directus_users']>['fields']
+         */
+        readMeFields?: Query<DirectusSchema, DirectusSchema['directus_users']>['fields'];
+        redirect?: {
+            /**
+             * Redirect to home page after login
+             * @default '/'
+             */
+            home?: string;
+            /**
+             * Redirect to login when using auth middleware
+             * @default '/auth/login'
+             */
+            login?: string;
+            /**
+             * Redirect to home page page after logout
+             * @default '/'
+             */
+            logout?: string;
+        };
+    };
+    types?: boolean | {
+        /**
+         * Enable type generation
+         * @type boolean
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * Prefix for custom collection types (does not affect DirectusSchema keys)
+         * @type string
+         * @default ''
+         */
+        prefix?: string;
+    };
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+interface NuxtDirectusModuleOptions extends ModuleOptions {
+    directusUrl: string;
+    wsProxyUrl?: string;
+}
+declare module '@nuxt/schema' {
+    interface ConfigSchema {
+        directus?: NuxtDirectusModuleOptions;
+        publicRuntimeConfig?: {
+            directus?: Omit<NuxtDirectusModuleOptions, 'adminToken'>;
+        };
+    }
+}
+
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-directus-sdk",
-  "version": "4.0.4",
+  "version": "5.0.0-beta.1",
   "configKey": "directus",
   "compatibility": {
     "nuxt": "^4.0.0"