@hesed/conni 0.4.0 → 0.5.0

package/README.md

@@ -26,7 +26,7 @@ $ npm install -g @hesed/conni
 $ conni COMMAND
 running command...
 $ conni (--version)
-@hesed/conni/0.4.0 darwin-arm64 node-v22.14.0
+@hesed/conni/0.5.0 linux-x64 node-v24.14.1
 $ conni --help [COMMAND]
 USAGE
   $ conni COMMAND
@@ -59,12 +59,12 @@ Add Atlassian authentication
 
 ```
 USAGE
-  $ conni conni auth add [--json] [-e <value>] [-t <value>] [-u <value>]
+  $ conni conni auth add -e <value> -t <value> -u <value> [--json]
 
 FLAGS
-  -e, --email=<value>  Account email:
-  -t, --token=<value>  API Token:
-  -u, --url=<value>    Atlassian URL (start with https://):
+  -e, --email=<value>  (required) Account email:
+  -t, --token=<value>  (required) API Token:
+  -u, --url=<value>    (required) Atlassian URL (start with https://):
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -76,7 +76,7 @@ EXAMPLES
   $ conni conni auth add
 ```
 
-_See code: [src/commands/conni/auth/add.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/auth/add.ts)_
+_See code: [src/commands/conni/auth/add.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/auth/add.ts)_
 
 ## `conni conni auth test`
 
@@ -96,7 +96,7 @@ EXAMPLES
   $ conni conni auth test
 ```
 
-_See code: [src/commands/conni/auth/test.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/auth/test.ts)_
+_See code: [src/commands/conni/auth/test.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/auth/test.ts)_
 
 ## `conni conni auth update`
 
@@ -104,12 +104,12 @@ Update existing authentication
 
 ```
 USAGE
-  $ conni conni auth update [--json] [-e <value>] [-t <value>] [-u <value>]
+  $ conni conni auth update -e <value> -t <value> -u <value> [--json]
 
 FLAGS
-  -e, --email=<value>  Account email
-  -t, --token=<value>  API Token
-  -u, --url=<value>    Atlassian instance URL (start with https://)
+  -e, --email=<value>  (required) Account email
+  -t, --token=<value>  (required) API Token
+  -u, --url=<value>    (required) Atlassian instance URL (start with https://)
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -121,7 +121,7 @@ EXAMPLES
   $ conni conni auth update
 ```
 
-_See code: [src/commands/conni/auth/update.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/auth/update.ts)_
+_See code: [src/commands/conni/auth/update.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/auth/update.ts)_
 
 ## `conni conni content attachment PAGEID FILE`
 
@@ -145,7 +145,7 @@ EXAMPLES
   $ conni conni content attachment 123456 ./document.pdf
 ```
 
-_See code: [src/commands/conni/content/attachment.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/attachment.ts)_
+_See code: [src/commands/conni/content/attachment.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/attachment.ts)_
 
 ## `conni conni content attachment-download ATTACHMENTID [OUTPUTPATH]`
 
@@ -171,7 +171,7 @@ EXAMPLES
   $ conni conni content attachment-download att12345 ./document.pdf
 ```
 
-_See code: [src/commands/conni/content/attachment-download.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/attachment-download.ts)_
+_See code: [src/commands/conni/content/attachment-download.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/attachment-download.ts)_
 
 ## `conni conni content comment PAGEID BODY`
 
@@ -204,7 +204,7 @@ EXAMPLES
   $ conni conni content comment 123456 "$(cat content.md)"
 ```
 
-_See code: [src/commands/conni/content/comment.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/comment.ts)_
+_See code: [src/commands/conni/content/comment.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/comment.ts)_
 
 ## `conni conni content comment-delete ID`
 
@@ -227,7 +227,7 @@ EXAMPLES
   $ conni conni content comment-delete 1544224770
 ```
 
-_See code: [src/commands/conni/content/comment-delete.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/comment-delete.ts)_
+_See code: [src/commands/conni/content/comment-delete.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/comment-delete.ts)_
 
 ## `conni conni content comment-update ID BODY`
 
@@ -260,7 +260,7 @@ EXAMPLES
   $ conni conni content comment-update 1544224770 "$(cat content.md)"
 ```
 
-_See code: [src/commands/conni/content/comment-update.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/comment-update.ts)_
+_See code: [src/commands/conni/content/comment-update.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/comment-update.ts)_
 
 ## `conni conni content create`
 
@@ -268,11 +268,12 @@ Create a new Confluence page
 
 ```
 USAGE
-  $ conni conni content create --fields <value>... [--attach <value>...] [--toon]
+  $ conni conni content create --fields <value>... [--attach <value>...] [--full-width] [--toon]
 
 FLAGS
   --attach=<value>...  Path to a file to upload and embed inline (can be used multiple times)
-  --fields=<value>...  (required) Content fields in key=value format
+  --fields=<value>...  (required) Minimum fields required: spaceKey, title & body
+  --full-width         Set page appearance to full-width
   --toon               Format output as toon
 
 DESCRIPTION
@@ -297,13 +298,15 @@ EXAMPLES
 
   $ conni conni content create --fields spaceKey="DEV" title="Page with files" body="Content" --attach ./image.png --attach ./report.pdf
 
+  $ conni conni content create --fields spaceKey="DEV" title="Storage page" body=@storage.xml representation=storage --full-width
+
 FLAG DESCRIPTIONS
-  --fields=<value>...  Content fields in key=value format
+  --fields=<value>...  Minimum fields required: spaceKey, title & body
 
-    Minimum fields required: spaceKey, title & body
+    Content fields in key=value format. Use @file to read value from a file (e.g. body=@content.xml)
 ```
 
-_See code: [src/commands/conni/content/create.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/create.ts)_
+_See code: [src/commands/conni/content/create.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/create.ts)_
 
 ## `conni conni content delete PAGEID`
 
@@ -326,7 +329,7 @@ EXAMPLES
   $ conni conni content delete 1543634992
 ```
 
-_See code: [src/commands/conni/content/delete.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/delete.ts)_
+_See code: [src/commands/conni/content/delete.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/delete.ts)_
 
 ## `conni conni content get PAGEID`
 
@@ -349,7 +352,7 @@ EXAMPLES
   $ conni conni content get 1544060948
 ```
 
-_See code: [src/commands/conni/content/get.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/get.ts)_
+_See code: [src/commands/conni/content/get.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/get.ts)_
 
 ## `conni conni content search CQL`
 
@@ -376,7 +379,7 @@ EXAMPLES
   $ conni conni content search 'created > startOfMonth()' --limit=5 --expand=body,version
 ```
 
-_See code: [src/commands/conni/content/search.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/search.ts)_
+_See code: [src/commands/conni/content/search.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/search.ts)_
 
 ## `conni conni content update PAGEID`
 
@@ -410,7 +413,7 @@ EXAMPLES
   $ conni conni content update 1076199489 --fields body="$(cat content.md)"
 ```
 
-_See code: [src/commands/conni/content/update.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/content/update.ts)_
+_See code: [src/commands/conni/content/update.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/content/update.ts)_
 
 ## `conni conni space get SPACEKEY`
 
@@ -433,7 +436,7 @@ EXAMPLES
   $ conni conni space get DEV
 ```
 
-_See code: [src/commands/conni/space/get.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/space/get.ts)_
+_See code: [src/commands/conni/space/get.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/space/get.ts)_
 
 ## `conni conni space list`
 
@@ -453,5 +456,5 @@ EXAMPLES
   $ conni conni space list
 ```
 
-_See code: [src/commands/conni/space/list.ts](https://github.com/hesedcasa/conni/blob/v0.4.0/src/commands/conni/space/list.ts)_
+_See code: [src/commands/conni/space/list.ts](https://github.com/hesedcasa/conni/blob/v0.5.0/src/commands/conni/space/list.ts)_
 <!-- commandsstop -->

package/dist/commands/conni/content/create.d.ts

@@ -6,6 +6,7 @@ export default class ContentCreate extends Command {
     static flags: {
         attach: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
         fields: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
+        'full-width': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         toon: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;

package/dist/commands/conni/content/create.js

@@ -1,4 +1,5 @@
 import { Command, Flags } from '@oclif/core';
+import fs from 'fs-extra';
 import { readConfig } from '../../../config.js';
 import { clearClients, createPage, createPageWithMedia } from '../../../conni/conni-client.js';
 import { formatAsToon } from '../../../format.js';
@@ -11,6 +12,7 @@ export default class ContentCreate extends Command {
         '<%= config.bin %> <%= command.id %> --fields spaceKey="DEV" title="Child page" body="Content" parentId="123456"',
         '<%= config.bin %> <%= command.id %> --fields spaceKey="DEV" title="Page with image" body="See the diagram:\n![diagram](./diagram.png)" --attach ./diagram.png',
         '<%= config.bin %> <%= command.id %> --fields spaceKey="DEV" title="Page with files" body="Content" --attach ./image.png --attach ./report.pdf',
+        '<%= config.bin %> <%= command.id %> --fields spaceKey="DEV" title="Storage page" body=@storage.xml representation=storage --full-width',
     ];
     static flags = {
         attach: Flags.string({
@@ -19,10 +21,14 @@ export default class ContentCreate extends Command {
             required: false,
         }),
         fields: Flags.string({
-            description: 'Minimum fields required: spaceKey, title & body',
+            description: 'Content fields in key=value format. Use @file to read value from a file (e.g. body=@content.xml)',
             multiple: true,
             required: true,
-            summary: 'Content fields in key=value format',
+            summary: 'Minimum fields required: spaceKey, title & body',
+        }),
+        'full-width': Flags.boolean({
+            description: 'Set page appearance to full-width',
+            required: false,
         }),
         toon: Flags.boolean({ description: 'Format output as toon', required: false }),
     };
@@ -36,7 +42,12 @@ export default class ContentCreate extends Command {
         if (flags.fields) {
             for (const field of flags.fields) {
                 const [key, ...valueParts] = field.split('=');
-                const value = valueParts.join('=');
+                let value = valueParts.join('=');
+                // Support @file syntax to read value from a file
+                if (value.startsWith('@')) {
+                    const filePath = value.slice(1);
+                    value = fs.readFileSync(filePath, 'utf8');
+                }
                 fields[key] = value;
             }
         }
@@ -46,6 +57,9 @@ export default class ContentCreate extends Command {
                 this.error(`Required field "${required}" is missing`);
             }
         }
+        if (flags['full-width']) {
+            fields.fullWidth = 'true';
+        }
         const result = flags.attach
             ? await createPageWithMedia(config.auth, fields, flags.attach)
             : await createPage(config.auth, fields);

package/dist/conni/conni-api.d.ts

@@ -74,6 +74,10 @@ export declare class ConniApi {
      * Search pages using CQL
      */
     searchContents(cql: string, limit?: number, expand?: string[]): Promise<ApiResult>;
+    /**
+     * Set page appearance (full-width or fixed-width)
+     */
+    setPageAppearance(pageId: string, appearance: string): Promise<ApiResult>;
     /**
      * Test Confluence API connection
      */

package/dist/conni/conni-api.js

@@ -108,6 +108,9 @@ export class ConniApi {
             const client = this.getClient();
             const { contentPayload } = this.buildPageBody(fields);
             const response = await client.content.createContent(contentPayload);
+            if (fields.fullWidth && response.id) {
+                await this.setPageAppearance(response.id, 'full-width');
+            }
             return { data: response, success: true };
         }
         catch (error) {
@@ -369,6 +372,24 @@ export class ConniApi {
             };
         }
     }
+    /**
+     * Set page appearance (full-width or fixed-width)
+     */
+    async setPageAppearance(pageId, appearance) {
+        try {
+            const client = this.getClient();
+            await Promise.all(['content-appearance-published', 'content-appearance-draft'].map((key) => client.contentProperties.createContentProperty({
+                id: pageId,
+                key,
+                value: appearance,
+            })));
+            return { success: true };
+        }
+        catch (error) {
+            const errorMessage = typeof error === 'object' ? String(error.message) : String(error);
+            return { error: errorMessage, success: false };
+        }
+    }
     /**
      * Test Confluence API connection
      */
@@ -477,8 +498,11 @@ export class ConniApi {
         }
     }
     buildPageBody(fields) {
+        const representation = fields.representation ?? 'atlas_doc_format';
+        const isStorage = representation === 'storage';
         // eslint-disable-next-line unicorn/prefer-string-replace-all
-        const bodyContent = markdownToAdf(fields.body.replace(/\\n/g, '\n'));
+        const rawBody = fields.body.replace(/\\n/g, '\n');
+        const bodyContent = isStorage ? rawBody : markdownToAdf(rawBody);
         const spaceKey = fields.spaceKey;
         const title = fields.title;
         const parentId = fields.parentId;
@@ -487,7 +511,7 @@ export class ConniApi {
             bodyContent,
             contentPayload: {
                 ancestors: parentId ? [{ id: parentId }] : undefined,
-                body: { storage: { representation: 'atlas_doc_format', value: JSON.stringify(bodyContent) } },
+                body: { storage: { representation, value: isStorage ? rawBody : JSON.stringify(bodyContent) } },
                 space: { key: spaceKey },
                 status,
                 title,

package/oclif.manifest.json

@@ -19,7 +19,7 @@
           "char": "e",
           "description": "Account email:",
           "name": "email",
-          "required": false,
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -28,7 +28,7 @@
           "char": "t",
           "description": "API Token:",
           "name": "token",
-          "required": false,
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -37,7 +37,7 @@
           "char": "u",
           "description": "Atlassian URL (start with https://):",
           "name": "url",
-          "required": false,
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -112,7 +112,7 @@
           "char": "e",
           "description": "Account email",
           "name": "email",
-          "required": false,
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -121,7 +121,7 @@
           "char": "t",
           "description": "API Token",
           "name": "token",
-          "required": false,
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -130,7 +130,7 @@
           "char": "u",
           "description": "Atlassian instance URL (start with https://)",
           "name": "url",
-          "required": false,
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -153,6 +153,78 @@
         "update.js"
       ]
     },
+    "conni:space:get": {
+      "aliases": [],
+      "args": {
+        "spaceKey": {
+          "description": "Space key",
+          "name": "spaceKey",
+          "required": true
+        }
+      },
+      "description": "Get details of a Confluence space",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> DEV"
+      ],
+      "flags": {
+        "toon": {
+          "description": "Format output as toon",
+          "name": "toon",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "conni:space:get",
+      "pluginAlias": "@hesed/conni",
+      "pluginName": "@hesed/conni",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "conni",
+        "space",
+        "get.js"
+      ]
+    },
+    "conni:space:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List all Confluence spaces",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "toon": {
+          "description": "Format output as toon",
+          "name": "toon",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "conni:space:list",
+      "pluginAlias": "@hesed/conni",
+      "pluginName": "@hesed/conni",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "conni",
+        "space",
+        "list.js"
+      ]
+    },
     "conni:content:attachment-download": {
       "aliases": [],
       "args": {
@@ -380,7 +452,8 @@
         "<%= config.bin %> <%= command.id %> --fields spaceKey=\"DEV\" title=\"New title\" body='\n# Header\n## Sub-header\n- Item 1\n- Item 2\n```bash\nls -a\n```'",
         "<%= config.bin %> <%= command.id %> --fields spaceKey=\"DEV\" title=\"Child page\" body=\"Content\" parentId=\"123456\"",
         "<%= config.bin %> <%= command.id %> --fields spaceKey=\"DEV\" title=\"Page with image\" body=\"See the diagram:\n![diagram](./diagram.png)\" --attach ./diagram.png",
-        "<%= config.bin %> <%= command.id %> --fields spaceKey=\"DEV\" title=\"Page with files\" body=\"Content\" --attach ./image.png --attach ./report.pdf"
+        "<%= config.bin %> <%= command.id %> --fields spaceKey=\"DEV\" title=\"Page with files\" body=\"Content\" --attach ./image.png --attach ./report.pdf",
+        "<%= config.bin %> <%= command.id %> --fields spaceKey=\"DEV\" title=\"Storage page\" body=@storage.xml representation=storage --full-width"
       ],
       "flags": {
         "attach": {
@@ -392,14 +465,21 @@
           "type": "option"
         },
         "fields": {
-          "description": "Minimum fields required: spaceKey, title & body",
+          "description": "Content fields in key=value format. Use @file to read value from a file (e.g. body=@content.xml)",
           "name": "fields",
           "required": true,
-          "summary": "Content fields in key=value format",
+          "summary": "Minimum fields required: spaceKey, title & body",
           "hasDynamicHelp": false,
           "multiple": true,
           "type": "option"
         },
+        "full-width": {
+          "description": "Set page appearance to full-width",
+          "name": "full-width",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
         "toon": {
           "description": "Format output as toon",
           "name": "toon",
@@ -600,79 +680,7 @@
         "content",
         "update.js"
       ]
-    },
-    "conni:space:get": {
-      "aliases": [],
-      "args": {
-        "spaceKey": {
-          "description": "Space key",
-          "name": "spaceKey",
-          "required": true
-        }
-      },
-      "description": "Get details of a Confluence space",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> DEV"
-      ],
-      "flags": {
-        "toon": {
-          "description": "Format output as toon",
-          "name": "toon",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "conni:space:get",
-      "pluginAlias": "@hesed/conni",
-      "pluginName": "@hesed/conni",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "conni",
-        "space",
-        "get.js"
-      ]
-    },
-    "conni:space:list": {
-      "aliases": [],
-      "args": {},
-      "description": "List all Confluence spaces",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>"
-      ],
-      "flags": {
-        "toon": {
-          "description": "Format output as toon",
-          "name": "toon",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "conni:space:list",
-      "pluginAlias": "@hesed/conni",
-      "pluginName": "@hesed/conni",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "conni",
-        "space",
-        "list.js"
-      ]
     }
   },
-  "version": "0.4.0"
+  "version": "0.5.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hesed/conni",
   "description": "CLI for Confluence API interaction",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "author": "Hesed",
   "bin": {
     "conni": "./bin/run.js"