decoupled-cli 2.0.2 → 2.1.0

package/examples/content-import-sample.json

@@ -1,114 +1,289 @@
 {
   "model": [
     {
-      "bundle": "event",
-      "description": "Content type for managing events, conferences, and gatherings",
-      "label": "Event",
+      "bundle": "article",
+      "description": "Blog articles and news posts with rich media and categorization",
+      "label": "Article",
       "body": true,
       "fields": [
         {
-          "id": "event_date",
-          "label": "Event Date",
-          "type": "datetime"
-        },
-        {
-          "id": "location",
-          "label": "Location",
-          "type": "string"
+          "id": "summary",
+          "label": "Summary",
+          "type": "string",
+          "description": "Short text field (max 255 chars) for article preview"
         },
         {
           "id": "featured_image",
           "label": "Featured Image",
-          "type": "image"
+          "type": "image",
+          "description": "Single image upload for article hero"
         },
         {
-          "id": "event_details",
-          "label": "Event Details",
-          "type": "paragraph(event_detail)[]"
+          "id": "published_date",
+          "label": "Published Date",
+          "type": "datetime",
+          "description": "Date and time field for publication scheduling"
+        },
+        {
+          "id": "author",
+          "label": "Author Name",
+          "type": "string"
         },
         {
           "id": "tags",
           "label": "Tags",
-          "type": "term(tags)[]"
+          "type": "term(tags)[]",
+          "description": "Multiple taxonomy term references"
         },
         {
           "id": "featured",
-          "label": "Featured",
-          "type": "bool"
+          "label": "Featured Article",
+          "type": "bool",
+          "description": "Boolean flag for promoting articles"
+        },
+        {
+          "id": "key_points",
+          "label": "Key Points",
+          "type": "string[]",
+          "description": "Multiple string values - best for simple lists without HTML"
+        },
+        {
+          "id": "gallery",
+          "label": "Image Gallery",
+          "type": "image[]",
+          "description": "Multiple image uploads"
+        },
+        {
+          "id": "content_blocks",
+          "label": "Content Blocks",
+          "type": "paragraph(content_block)[]",
+          "description": "Multiple paragraph entity references for structured content"
         }
       ]
     },
     {
       "entity": "paragraph",
-      "bundle": "event_detail",
-      "description": "Reusable content blocks for event information and details",
-      "label": "Event Detail",
+      "bundle": "content_block",
+      "description": "Reusable content blocks with images and formatted text",
+      "label": "Content Block",
       "fields": [
         {
-          "id": "detail_title",
-          "label": "Detail Title",
-          "type": "string!"
+          "id": "block_title",
+          "label": "Block Title",
+          "type": "string!",
+          "description": "Required field (note the ! suffix)"
         },
         {
-          "id": "detail_content",
-          "label": "Detail Content",
-          "type": "text"
+          "id": "block_content",
+          "label": "Block Content",
+          "type": "text",
+          "description": "Long text with HTML formatting"
         },
         {
-          "id": "detail_image",
-          "label": "Detail Image",
+          "id": "block_image",
+          "label": "Block Image",
           "type": "image"
         }
       ]
+    },
+    {
+      "bundle": "product",
+      "description": "E-commerce products with pricing, inventory, and specifications",
+      "label": "Product",
+      "body": true,
+      "fields": [
+        {
+          "id": "price",
+          "label": "Price",
+          "type": "string",
+          "description": "Product price as formatted string (e.g. '$299.99')"
+        },
+        {
+          "id": "sku",
+          "label": "SKU",
+          "type": "string",
+          "description": "Product identifier"
+        },
+        {
+          "id": "in_stock",
+          "label": "In Stock",
+          "type": "bool"
+        },
+        {
+          "id": "product_images",
+          "label": "Product Images",
+          "type": "image[]",
+          "description": "Multiple product photos"
+        },
+        {
+          "id": "features",
+          "label": "Key Features",
+          "type": "string[]",
+          "description": "List of product features (plain text, no HTML)"
+        },
+        {
+          "id": "specifications",
+          "label": "Specifications",
+          "type": "string[]",
+          "description": "Technical specifications"
+        },
+        {
+          "id": "category",
+          "label": "Product Category",
+          "type": "term(product_category)[]"
+        }
+      ]
     }
   ],
   "content": [
     {
-      "id": "detail1",
-      "type": "paragraph.event_detail",
+      "id": "block1",
+      "type": "paragraph.content_block",
       "values": {
-        "detail_title": "Schedule",
-        "detail_content": "The event will run from 9:00 AM to 5:00 PM with lunch break at noon.",
-        "detail_image": {
-          "uri": "/modules/custom/dcloud_import/resources/placeholder.png",
-          "alt": "Event schedule timeline showing sessions and breaks",
-          "title": "Conference Schedule"
+        "block_title": "Introduction",
+        "block_content": "<p>This is an <strong>example content block</strong> with formatted text.</p>",
+        "block_image": {
+          "uri": "${DRUPAL_BASE_URL}/modules/custom/dc_import/resources/placeholder.png",
+          "alt": "Content block illustration",
+          "title": "Block Image"
         }
       }
     },
     {
-      "id": "detail2",
-      "type": "paragraph.event_detail",
+      "id": "article1",
+      "type": "node.article",
+      "path": "/articles/getting-started-with-drupal",
       "values": {
-        "detail_title": "Speakers",
-        "detail_content": "Join us for presentations by industry experts and thought leaders."
+        "title": "Getting Started with Decoupled Drupal",
+        "summary": "Learn how to build modern web applications with Drupal as a headless CMS",
+        "body": "<p>Decoupled Drupal enables you to use Drupal as a powerful content management backend while building your frontend with modern JavaScript frameworks.</p><p>This architecture provides flexibility, performance, and an excellent developer experience.</p>",
+        "published_date": "2024-03-15T09:00:00",
+        "author": "Jane Smith",
+        "featured": true,
+        "key_points": [
+          "Use Drupal for content management",
+          "Build frontend with Next.js, React, or Vue",
+          "Connect via GraphQL or REST API",
+          "Deploy frontend and backend independently"
+        ],
+        "featured_image": {
+          "uri": "${DRUPAL_BASE_URL}/modules/custom/dc_import/resources/placeholder.png",
+          "alt": "Decoupled Drupal architecture diagram",
+          "title": "Architecture Overview"
+        },
+        "gallery": [
+          {
+            "uri": "${DRUPAL_BASE_URL}/modules/custom/dc_import/resources/placeholder.png",
+            "alt": "Screenshot of content management interface",
+            "title": "CMS Interface"
+          },
+          {
+            "uri": "${DRUPAL_BASE_URL}/modules/custom/dc_import/resources/placeholder.png",
+            "alt": "Frontend application example",
+            "title": "Frontend App"
+          }
+        ],
+        "tags": [
+          "drupal",
+          "headless-cms",
+          "web-development"
+        ],
+        "content_blocks": [
+          "@block1"
+        ]
       }
     },
     {
-      "id": "event1",
-      "type": "node.event",
-      "path": "/events/web-dev-conference-2024",
+      "id": "product1",
+      "type": "node.product",
+      "path": "/products/wireless-charger-pro",
       "values": {
-        "title": "Web Development Conference 2024",
-        "body": "<p>Join us for a full day of learning about modern web development...</p>",
-        "event_date": "2024-03-15T09:00:00",
-        "location": "Convention Center Downtown",
-        "featured_image": {
-          "uri": "/modules/custom/dcloud_import/resources/placeholder.png",
-          "alt": "Web Development Conference 2024 promotional image",
-          "title": "Conference Hero Image"
-        },
-        "tags": [
-          "web-development",
-          "conference",
-          "technology"
+        "title": "Wireless Charger Pro",
+        "body": "<p>Experience the future of charging with our premium wireless charging pad. Sleek design meets powerful performance.</p>",
+        "price": "$79.99",
+        "sku": "WCP-2024-BLK",
+        "in_stock": true,
+        "features": [
+          "Fast 15W wireless charging",
+          "Qi-compatible with all devices",
+          "Non-slip rubberized surface",
+          "LED charging indicator",
+          "Overheat protection"
         ],
-        "featured": true,
-        "event_details": [
-          "@detail1",
-          "@detail2"
+        "specifications": [
+          "Input: USB-C 5V/3A",
+          "Output: 15W max",
+          "Size: 4 x 4 x 0.5 inches",
+          "Weight: 3.2 oz",
+          "Color: Matte Black"
+        ],
+        "product_images": [
+          {
+            "uri": "${DRUPAL_BASE_URL}/modules/custom/dc_import/resources/placeholder.png",
+            "alt": "Wireless Charger Pro front view",
+            "title": "Product Front"
+          },
+          {
+            "uri": "${DRUPAL_BASE_URL}/modules/custom/dc_import/resources/placeholder.png",
+            "alt": "Wireless Charger Pro with phone charging",
+            "title": "In Use"
+          }
+        ],
+        "category": [
+          "electronics",
+          "accessories"
         ]
       }
     }
-  ]
+  ],
+  "_comments": {
+    "field_types": {
+      "string": "Short text (max 255 chars), plain text only",
+      "text": "Long text with HTML formatting support",
+      "string[]": "Multiple string values - best for simple lists like features, tags, specifications",
+      "text[]": "Multiple text values with HTML - use sparingly, prefer string[] for lists",
+      "image": "Single image upload with uri, alt, title properties",
+      "image[]": "Multiple image uploads",
+      "datetime": "Date and time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss)",
+      "bool": "Boolean true/false value",
+      "term(vocabulary)[]": "Taxonomy term references, creates/assigns terms automatically",
+      "paragraph(bundle)[]": "References to paragraph entities for structured content",
+      "string!": "Required field (note the ! suffix)"
+    },
+    "image_format": {
+      "description": "Images require full URLs with Drupal domain, not relative paths",
+      "example": {
+        "uri": "${DRUPAL_BASE_URL}/modules/custom/dc_import/resources/placeholder.png",
+        "alt": "Descriptive alt text for accessibility",
+        "title": "Image title"
+      },
+      "note": "Replace ${DRUPAL_BASE_URL} with actual Drupal URL from .env.local"
+    },
+    "content_references": {
+      "description": "Reference other content items using @id syntax",
+      "example": "\"content_blocks\": [\"@block1\", \"@block2\"]",
+      "note": "Referenced content must be defined earlier in the content array"
+    },
+    "field_naming": {
+      "important": "In DC import JSON, use field 'id' directly (e.g., 'price'), NOT 'field_price'",
+      "note": "Drupal automatically prefixes with 'field_' internally",
+      "graphql": "GraphQL field names may transform to camelCase (e.g., in_stock → inStock)"
+    },
+    "best_practices": [
+      "Use string[] for simple lists (features, specifications) - avoids HTML rendering complexity",
+      "Use text[] only when you need rich HTML formatting within each list item",
+      "Always include sample content for immediate testing",
+      "Use descriptive field IDs that are clear and consistent",
+      "Include alt text for all images for accessibility",
+      "Set body: true to include standard body field",
+      "Use path aliases following /content-type/slug pattern"
+    ],
+    "common_patterns": {
+      "e-commerce": "price (string), sku (string), in_stock (bool), product_images (image[]), features (string[])",
+      "blog": "summary (string), author (string), published_date (datetime), tags (term[]), featured (bool)",
+      "events": "event_date (datetime), location (string), registration_url (string), speakers (string[])",
+      "team": "position (string), profile_image (image), bio (text), social_links (string[])",
+      "portfolio": "project_url (string), technologies (string[]), project_images (image[]), client (string)"
+    }
+  }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "decoupled-cli",
-  "version": "2.0.2",
-  "description": "Command-line interface for DrupalCloud API management",
+  "version": "2.1.0",
+  "description": "Command-line interface for Decoupled Drupal API management",
   "main": "dist/index.js",
   "bin": {
     "decoupled-cli": "bin/decoupled-cli"
@@ -21,7 +21,7 @@
     "drupal",
     "cloud"
   ],
-  "author": "DrupalCloud",
+  "author": "Decoupled Drupal",
   "license": "MIT",
   "dependencies": {
     "@types/node-fetch": "^2.6.13",

package/dist/commands/tokens.d.ts

@@ -1,3 +0,0 @@
-import { Command } from 'commander';
-export declare const tokensCommand: Command;
-//# sourceMappingURL=tokens.d.ts.map

package/dist/commands/tokens.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/commands/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKpC,eAAO,MAAM,aAAa,SACS,CAAC"}

package/dist/commands/tokens.js

@@ -1,90 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tokensCommand = void 0;
-const commander_1 = require("commander");
-const chalk_1 = __importDefault(require("chalk"));
-const cli_table3_1 = __importDefault(require("cli-table3"));
-const api_1 = require("../lib/api");
-exports.tokensCommand = new commander_1.Command('tokens')
-    .description('Manage API tokens');
-exports.tokensCommand
-    .command('list')
-    .description('List all tokens')
-    .option('--detailed', 'show detailed information')
-    .option('--json', 'output as JSON')
-    .action(async (options) => {
-    try {
-        const client = await (0, api_1.createApiClient)();
-        const tokens = await client.getTokens();
-        if (options.json) {
-            console.log(JSON.stringify(tokens, null, 2));
-        }
-        else {
-            console.log(chalk_1.default.bold('\n🔑 API Tokens'));
-            console.log('─────────────');
-            if (tokens.tokens && tokens.tokens.length > 0) {
-                const table = new cli_table3_1.default({
-                    head: [
-                        chalk_1.default.cyan('ID'),
-                        chalk_1.default.cyan('Name'),
-                        chalk_1.default.cyan('Status'),
-                        chalk_1.default.cyan('Expires'),
-                        chalk_1.default.cyan('Created')
-                    ],
-                    style: {
-                        head: [],
-                        border: []
-                    }
-                });
-                tokens.tokens.forEach((token) => {
-                    const statusColor = token.isActive ? chalk_1.default.green : chalk_1.default.red;
-                    const status = token.isActive ? 'Active' : 'Inactive';
-                    const expires = token.expiresAt ? new Date(token.expiresAt).toLocaleDateString() : 'Never';
-                    const created = new Date(token.createdAt).toLocaleDateString();
-                    table.push([
-                        token.id.toString(),
-                        token.name,
-                        statusColor(status),
-                        expires,
-                        created
-                    ]);
-                });
-                console.log(table.toString());
-            }
-            else {
-                console.log(chalk_1.default.gray('No tokens found. Note: Token-based authentication cannot list tokens for security reasons.'));
-            }
-        }
-    }
-    catch (error) {
-        if (error instanceof Error && (error.message.includes('Token-based authentication cannot manage tokens') ||
-            error.message.includes('Insufficient permissions for this operation'))) {
-            console.log(chalk_1.default.yellow('⚠️  Token-based authentication cannot list tokens for security reasons.'));
-            console.log(chalk_1.default.gray('Use session-based authentication in the web interface to manage tokens.'));
-        }
-        else {
-            console.error(chalk_1.default.red('❌ Failed to list tokens:'), error instanceof Error ? error.message : String(error));
-            process.exit(1);
-        }
-    }
-});
-exports.tokensCommand
-    .command('create <name>')
-    .description('Create a new token')
-    .option('--preset <preset>', 'permission preset (read-only, spaces-manager, full-access)')
-    .option('--permissions <permissions>', 'custom permissions (comma-separated)')
-    .option('--expires <date>', 'expiration date (YYYY-MM-DD)')
-    .action(async (name, options) => {
-    try {
-        console.log(chalk_1.default.yellow('⚠️  Token creation is only available through session-based authentication.'));
-        console.log(chalk_1.default.gray('Please use the web interface to create new tokens for security reasons.'));
-    }
-    catch (error) {
-        console.error(chalk_1.default.red('❌ Failed to create token:'), error instanceof Error ? error.message : String(error));
-        process.exit(1);
-    }
-});
-//# sourceMappingURL=tokens.js.map

package/dist/commands/tokens.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/commands/tokens.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAoC;AACpC,kDAA0B;AAC1B,4DAA+B;AAC/B,oCAA6C;AAEhC,QAAA,aAAa,GAAG,IAAI,mBAAO,CAAC,QAAQ,CAAC;KAC/C,WAAW,CAAC,mBAAmB,CAAC,CAAC;AAEpC,qBAAa;KACV,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CAAC,iBAAiB,CAAC;KAC9B,MAAM,CAAC,YAAY,EAAE,2BAA2B,CAAC;KACjD,MAAM,CAAC,QAAQ,EAAE,gBAAgB,CAAC;KAClC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAe,GAAE,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;QAExC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC3C,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAE7B,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9C,MAAM,KAAK,GAAG,IAAI,oBAAK,CAAC;oBACtB,IAAI,EAAE;wBACJ,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC;wBAChB,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC;wBAClB,eAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;wBACpB,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC;wBACrB,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC;qBACtB;oBACD,KAAK,EAAE;wBACL,IAAI,EAAE,EAAE;wBACR,MAAM,EAAE,EAAE;qBACX;iBACF,CAAC,CAAC;gBAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,EAAE;oBACnC,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,eAAK,CAAC,KAAK,CAAC,CAAC,CAAC,eAAK,CAAC,GAAG,CAAC;oBAC7D,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC;oBACtD,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;oBAC3F,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC;oBAE/D,KAAK,CAAC,IAAI,CAAC;wBACT,KAAK,CAAC,EAAE,CAAC,QAAQ,EAAE;wBACnB,KAAK,CAAC,IAAI;wBACV,WAAW,CAAC,MAAM,CAAC;wBACnB,OAAO;wBACP,OAAO;qBACR,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;gBAEH,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,4FAA4F,CAAC,CAAC,CAAC;YACxH,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,IAAI,KAAK,YAAY,KAAK,IAAI,CAC5B,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,iDAAiD,CAAC;YACzE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,6CAA6C,CAAC,CACtE,EAAE,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,yEAAyE,CAAC,CAAC,CAAC;YACrG,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAC,CAAC;QACrG,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,0BAA0B,CAAC,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7G,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,qBAAa;KACV,OAAO,CAAC,eAAe,CAAC;KACxB,WAAW,CAAC,oBAAoB,CAAC;KACjC,MAAM,CAAC,mBAAmB,EAAE,4DAA4D,CAAC;KACzF,MAAM,CAAC,6BAA6B,EAAE,sCAAsC,CAAC;KAC7E,MAAM,CAAC,kBAAkB,EAAE,8BAA8B,CAAC;KAC1D,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;IAC9B,IAAI,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,4EAA4E,CAAC,CAAC,CAAC;QACxG,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAC,CAAC;IACrG,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,2BAA2B,CAAC,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9G,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC"}