@hesed/conni 0.1.0

package/README.md

@@ -0,0 +1,449 @@
+# conni
+
+CLI for Confluence API interaction
+
+[![Version](https://img.shields.io/npm/v/@hesed/conni.svg)](https://npmjs.org/package/@hesed/conni)
+[![Downloads/week](https://img.shields.io/npm/dw/@hesed/conni.svg)](https://npmjs.org/package/@hesed/conni)
+
+# Install
+
+```bash
+sdkck plugins install @hesed/conni
+```
+
+<!-- toc -->
+* [conni](#conni)
+* [Install](#install)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Usage
+
+<!-- usage -->
+```sh-session
+$ npm install -g @hesed/conni
+$ conni COMMAND
+running command...
+$ conni (--version)
+@hesed/conni/0.1.0 darwin-arm64 node-v22.14.0
+$ conni --help [COMMAND]
+USAGE
+  $ conni COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+
+<!-- commands -->
+* [`conni conni auth add`](#conni-conni-auth-add)
+* [`conni conni auth test`](#conni-conni-auth-test)
+* [`conni conni auth update`](#conni-conni-auth-update)
+* [`conni conni content attachment PAGEID FILE`](#conni-conni-content-attachment-pageid-file)
+* [`conni conni content attachment-download ATTACHMENTID [OUTPUTPATH]`](#conni-conni-content-attachment-download-attachmentid-outputpath)
+* [`conni conni content comment PAGEID BODY`](#conni-conni-content-comment-pageid-body)
+* [`conni conni content comment-delete ID`](#conni-conni-content-comment-delete-id)
+* [`conni conni content comment-update ID BODY`](#conni-conni-content-comment-update-id-body)
+* [`conni conni content create`](#conni-conni-content-create)
+* [`conni conni content delete PAGEID`](#conni-conni-content-delete-pageid)
+* [`conni conni content get PAGEID`](#conni-conni-content-get-pageid)
+* [`conni conni content search CQL`](#conni-conni-content-search-cql)
+* [`conni conni content update PAGEID`](#conni-conni-content-update-pageid)
+* [`conni conni space get SPACEKEY`](#conni-conni-space-get-spacekey)
+* [`conni conni space list`](#conni-conni-space-list)
+
+## `conni conni auth add`
+
+Add Atlassian authentication
+
+```
+USAGE
+  $ conni conni auth add [--json] [-e <value>] [-t <value>] [-u <value>]
+
+FLAGS
+  -e, --email=<value>  Account email:
+  -t, --token=<value>  API Token:
+  -u, --url=<value>    Atlassian URL (start with https://):
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Add Atlassian authentication
+
+EXAMPLES
+  $ conni conni auth add
+```
+
+_See code: [src/commands/conni/auth/add.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/auth/add.ts)_
+
+## `conni conni auth test`
+
+Test authentication and connection
+
+```
+USAGE
+  $ conni conni auth test [--json]
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Test authentication and connection
+
+EXAMPLES
+  $ conni conni auth test
+```
+
+_See code: [src/commands/conni/auth/test.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/auth/test.ts)_
+
+## `conni conni auth update`
+
+Update existing authentication
+
+```
+USAGE
+  $ conni conni auth update [--json] [-e <value>] [-t <value>] [-u <value>]
+
+FLAGS
+  -e, --email=<value>  Account email
+  -t, --token=<value>  API Token
+  -u, --url=<value>    Atlassian instance URL (start with https://)
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Update existing authentication
+
+EXAMPLES
+  $ conni conni auth update
+```
+
+_See code: [src/commands/conni/auth/update.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/auth/update.ts)_
+
+## `conni conni content attachment PAGEID FILE`
+
+Add attachment to Confluence content
+
+```
+USAGE
+  $ conni conni content attachment PAGEID FILE [--toon]
+
+ARGUMENTS
+  PAGEID  Page ID
+  FILE    Path to the file to upload
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  Add attachment to Confluence content
+
+EXAMPLES
+  $ conni conni content attachment 123456 ./document.pdf
+```
+
+_See code: [src/commands/conni/content/attachment.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/content/attachment.ts)_
+
+## `conni conni content attachment-download ATTACHMENTID [OUTPUTPATH]`
+
+Download attachment from Confluence content
+
+```
+USAGE
+  $ conni conni content attachment-download ATTACHMENTID [OUTPUTPATH] [--toon]
+
+ARGUMENTS
+  ATTACHMENTID  Attachment ID
+  [OUTPUTPATH]  Output file path
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  Download attachment from Confluence content
+
+EXAMPLES
+  $ conni conni content attachment-download att12345
+
+  $ conni conni content attachment-download att12345 ./document.pdf
+```
+
+_See code: [src/commands/conni/content/attachment-download.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/content/attachment-download.ts)_
+
+## `conni conni content comment PAGEID BODY`
+
+Add comment to Confluence content
+
+```
+USAGE
+  $ conni conni content comment PAGEID BODY [--toon]
+
+ARGUMENTS
+  PAGEID  Page ID
+  BODY    Comment in Markdown format
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  Add comment to Confluence content
+
+EXAMPLES
+  $ conni conni content comment 123456 "
+  # Header
+  ## Sub-header
+  - Item 1
+  - Item 2
+  ```bash
+  ls -a
+  ```"
+
+  $ conni conni content comment 123456 "$(cat content.md)"
+```
+
+_See code: [src/commands/conni/content/comment.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/content/comment.ts)_
+
+## `conni conni content comment-delete ID`
+
+Delete comment from Confluence content
+
+```
+USAGE
+  $ conni conni content comment-delete ID [--toon]
+
+ARGUMENTS
+  ID  Comment ID to delete
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  Delete comment from Confluence content
+
+EXAMPLES
+  $ conni conni content comment-delete 1544224770
+```
+
+_See code: [src/commands/conni/content/comment-delete.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/content/comment-delete.ts)_
+
+## `conni conni content comment-update ID BODY`
+
+Update a comment
+
+```
+USAGE
+  $ conni conni content comment-update ID BODY [--toon]
+
+ARGUMENTS
+  ID    Comment ID to update
+  BODY  Comment in Markdown format
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  Update a comment
+
+EXAMPLES
+  $ conni conni content comment-update 1544224770 "
+  # Header
+  ## Sub-header
+  - Item 1
+  - Item 2
+  ```bash
+  ls -a
+  ```"
+
+  $ 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.1.0/src/commands/conni/content/comment-update.ts)_
+
+## `conni conni content create`
+
+Create a new Confluence page
+
+```
+USAGE
+  $ conni conni content create --fields <value>... [--toon]
+
+FLAGS
+  --fields=<value>...  (required) Content fields in key=value format
+  --toon               Format output as toon
+
+DESCRIPTION
+  Create a new Confluence page
+
+EXAMPLES
+  $ conni conni content create --fields spaceKey="DEV" title="New title" body="New description" status="draft"
+
+  $ conni conni content create --fields spaceKey="DEV" title="New title" body='
+  # Header
+  ## Sub-header
+  - Item 1
+  - Item 2
+  ```bash
+  ls -a
+  ```'
+
+FLAG DESCRIPTIONS
+  --fields=<value>...  Content fields in key=value format
+
+    Minimum fields required: spaceKey, title & body
+```
+
+_See code: [src/commands/conni/content/create.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/content/create.ts)_
+
+## `conni conni content delete PAGEID`
+
+Delete a Confluence page
+
+```
+USAGE
+  $ conni conni content delete PAGEID [--toon]
+
+ARGUMENTS
+  PAGEID  Page ID to delete
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  Delete a Confluence page
+
+EXAMPLES
+  $ conni conni content delete 1543634992
+```
+
+_See code: [src/commands/conni/content/delete.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/content/delete.ts)_
+
+## `conni conni content get PAGEID`
+
+Get details of a Confluence content
+
+```
+USAGE
+  $ conni conni content get PAGEID [--toon]
+
+ARGUMENTS
+  PAGEID  Page ID
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  Get details of a Confluence content
+
+EXAMPLES
+  $ conni conni content get 1544060948
+```
+
+_See code: [src/commands/conni/content/get.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/content/get.ts)_
+
+## `conni conni content search CQL`
+
+Search for Confluence contents using CQL
+
+```
+USAGE
+  $ conni conni content search CQL [--expand <value>] [--limit <value>] [--toon]
+
+ARGUMENTS
+  CQL  CQL expression
+
+FLAGS
+  --expand=<value>  Properties of the content to expand
+  --limit=<value>   Maximum number of contents per page
+  --toon            Format output as toon
+
+DESCRIPTION
+  Search for Confluence contents using CQL
+
+EXAMPLES
+  $ conni conni content search 'space=DEV AND title ~ "Implement email OTP login" AND creator=currentUser()'
+
+  $ 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.1.0/src/commands/conni/content/search.ts)_
+
+## `conni conni content update PAGEID`
+
+Update an existing Confluence content
+
+```
+USAGE
+  $ conni conni content update PAGEID --fields <value>...
+
+ARGUMENTS
+  PAGEID  Page ID
+
+FLAGS
+  --fields=<value>...  (required) Content fields to update in key=value format
+
+DESCRIPTION
+  Update an existing Confluence content
+
+EXAMPLES
+  $ conni conni content update 1076199489 --fields title='New summary' body='New description'
+
+  $ conni conni content update 1076199489 --fields body='
+  # Header
+  ## Sub-header
+  - Item 1
+  - Item 2
+  ```bash
+  ls -a
+  ```'
+
+  $ 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.1.0/src/commands/conni/content/update.ts)_
+
+## `conni conni space get SPACEKEY`
+
+Get details of a Confluence space
+
+```
+USAGE
+  $ conni conni space get SPACEKEY [--toon]
+
+ARGUMENTS
+  SPACEKEY  Space key
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  Get details of a Confluence space
+
+EXAMPLES
+  $ conni conni space get DEV
+```
+
+_See code: [src/commands/conni/space/get.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/space/get.ts)_
+
+## `conni conni space list`
+
+List all Confluence spaces
+
+```
+USAGE
+  $ conni conni space list [--toon]
+
+FLAGS
+  --toon  Format output as toon
+
+DESCRIPTION
+  List all Confluence spaces
+
+EXAMPLES
+  $ conni conni space list
+```
+
+_See code: [src/commands/conni/space/list.ts](https://github.com/hesedcasa/conni/blob/v0.1.0/src/commands/conni/space/list.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/conni/auth/add.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+import { ApiResult } from '../../../conni/conni-api.js';
+export default class AuthAdd extends Command {
+    static args: {};
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        email: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        token: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        url: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<ApiResult>;
+}

package/dist/commands/conni/auth/add.js

@@ -0,0 +1,55 @@
+import { input } from '@inquirer/prompts';
+import { Command, Flags } from '@oclif/core';
+import { action } from '@oclif/core/ux';
+import { default as fs } from 'fs-extra';
+import { default as path } from 'node:path';
+import { clearClients, testConnection } from '../../../conni/conni-client.js';
+export default class AuthAdd extends Command {
+    static args = {};
+    static description = 'Add Atlassian authentication';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        email: Flags.string({ char: 'e', description: 'Account email:', required: !process.stdout.isTTY }),
+        token: Flags.string({ char: 't', description: 'API Token:', required: !process.stdout.isTTY }),
+        url: Flags.string({
+            char: 'u',
+            description: 'Atlassian URL (start with https://):',
+            required: !process.stdout.isTTY,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AuthAdd);
+        const apiToken = flags.token ?? (await input({ message: 'API Token:', required: true }));
+        const email = flags.email ?? (await input({ message: 'Account email:', required: true }));
+        const host = flags.url ?? (await input({ message: 'Atlassian instance URL (start with https://):', required: true }));
+        const configPath = path.join(this.config.configDir, 'conni-config.json');
+        const auth = {
+            auth: {
+                apiToken,
+                email,
+                host,
+            },
+        };
+        const exists = await fs.pathExists(configPath);
+        if (!exists) {
+            await fs.createFile(configPath);
+        }
+        await fs.writeJSON(configPath, auth, {
+            mode: 0o600, // owner read/write only
+        });
+        action.start('Authenticating');
+        const config = await fs.readJSON(configPath);
+        const result = await testConnection(config.auth);
+        clearClients();
+        if (result.success) {
+            action.stop('✓ successful');
+            this.log('Authentication added successfully');
+        }
+        else {
+            action.stop('✗ failed');
+            this.error('Authentication is invalid. Please check your email, token, and URL.');
+        }
+        return result;
+    }
+}

package/dist/commands/conni/auth/test.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+import { ApiResult } from '../../../conni/conni-api.js';
+export default class AuthTest extends Command {
+    static args: {};
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<ApiResult>;
+}

package/dist/commands/conni/auth/test.js

@@ -0,0 +1,32 @@
+import { Command } from '@oclif/core';
+import { action } from '@oclif/core/ux';
+import { readConfig } from '../../../config.js';
+import { clearClients, testConnection } from '../../../conni/conni-client.js';
+export default class AuthTest extends Command {
+    static args = {};
+    static description = 'Test authentication and connection';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {};
+    async run() {
+        const config = await readConfig(this.config.configDir, this.log.bind(this));
+        if (!config) {
+            return {
+                error: 'Missing authentication config',
+                success: false,
+            };
+        }
+        action.start('Authenticating connection');
+        const result = await testConnection(config.auth);
+        clearClients();
+        if (result.success) {
+            action.stop('✓ successful');
+            this.log('Successful connect to Confluence');
+        }
+        else {
+            action.stop('✗ failed');
+            this.error('Failed to connect to Confluence.');
+        }
+        return result;
+    }
+}

package/dist/commands/conni/auth/update.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+import { ApiResult } from '../../../conni/conni-api.js';
+export default class AuthUpdate extends Command {
+    static args: {};
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        email: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        token: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        url: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<ApiResult | void>;
+}

package/dist/commands/conni/auth/update.js

@@ -0,0 +1,77 @@
+import { confirm, input } from '@inquirer/prompts';
+import { Command, Flags } from '@oclif/core';
+import { action } from '@oclif/core/ux';
+import { default as fs } from 'fs-extra';
+import { default as path } from 'node:path';
+import { clearClients, testConnection } from '../../../conni/conni-client.js';
+export default class AuthUpdate extends Command {
+    static args = {};
+    static description = 'Update existing authentication';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        email: Flags.string({ char: 'e', description: 'Account email', required: !process.stdout.isTTY }),
+        token: Flags.string({ char: 't', description: 'API Token', required: !process.stdout.isTTY }),
+        url: Flags.string({
+            char: 'u',
+            description: 'Atlassian instance URL (start with https://)',
+            required: !process.stdout.isTTY,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AuthUpdate);
+        const configPath = path.join(this.config.configDir, 'conni-config.json');
+        let config;
+        try {
+            config = await fs.readJSON(configPath);
+        }
+        catch (error) {
+            const msg = error instanceof Error ? error.message : String(error);
+            if (msg.toLowerCase().includes('no such file or directory')) {
+                this.log('Run auth:add instead');
+            }
+            else {
+                this.log(msg);
+            }
+            return;
+        }
+        const apiToken = flags.token ??
+            (await input({ default: config.auth.apiToken, message: 'API Token:', prefill: 'tab', required: true }));
+        const email = flags.email ??
+            (await input({ default: config.auth.email, message: 'Account email:', prefill: 'tab', required: true }));
+        const host = flags.url ??
+            (await input({
+                default: config.auth.host,
+                message: 'Atlassian instance URL (start with https://):',
+                prefill: 'tab',
+                required: true,
+            }));
+        const answer = await confirm({ message: 'Override existing config?' });
+        if (!answer) {
+            return;
+        }
+        const auth = {
+            auth: {
+                apiToken,
+                email,
+                host,
+            },
+        };
+        await fs.writeJSON(configPath, auth, {
+            mode: 0o600, // owner read/write only
+        });
+        action.start('Authenticating');
+        config = await fs.readJSON(configPath);
+        const result = await testConnection(config.auth);
+        clearClients();
+        if (result.success) {
+            action.stop('✓ successful');
+            this.log('Authentication updated successfully');
+        }
+        else {
+            action.stop('✗ failed');
+            this.error('Authentication is invalid. Please check your email, token, and URL.');
+        }
+        return result;
+    }
+}

package/dist/commands/conni/content/attachment-download.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '@oclif/core';
+export default class ContentDownloadAttachment extends Command {
+    static args: {
+        attachmentId: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        outputPath: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        toon: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}