feat(VEG-4340): Bootstrap a new package to onboard CLI commands for Connector SDK

Author: saikambaiyyagari

packages/zcli-connectors/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [1.0.0-beta.1](https://github.com/zendesk/zcli/compare/v1.0.0-beta.0...v1.0.0-beta.1) (2026-01-12)
+
+**Note:** Initial version for zcli-connectors package

packages/zcli-connectors/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().catch(require('@oclif/core/handle'))

packages/zcli-connectors/bin/run.cmd

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

packages/zcli-connectors/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@zendesk/zcli-connectors",
+  "description": "zcli connectors commands live here",
+  "version": "1.0.0-beta.1",
+  "author": "@vegemite",
+  "npmRegistry": "https://registry.npmjs.org",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "zcli-connectors": "./bin/run"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepack": "tsc && ../../scripts/prepack.sh",
+    "postpack": "rm -f oclif.manifest.json npm-shrinkwrap.json && rm -rf ./dist && git checkout ./package.json",
+    "type:check": "tsc"
+  },
+  "dependencies": {
+    "adm-zip": "0.5.10",
+    "archiver": "^5.3.1",
+    "axios": "^1.7.5",
+    "chalk": "^4.1.2",
+    "fs-extra": "^10.0.0",
+    "rimraf": "^3.0.2",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@oclif/test": "=2.1.0",
+    "@types/adm-zip": "^0.5.5",
+    "@types/archiver": "^5.3.1",
+    "@types/chai": "^4",
+    "@types/mocha": "^9.1.1",
+    "@types/rimraf": "^3.0.2",
+    "chai": "^4",
+    "eslint": "^8.18.0",
+    "eslint-config-oclif": "^4.0.0",
+    "eslint-config-oclif-typescript": "^1.0.2",
+    "lerna": "^5.6.2",
+    "mocha": "^10.8.2",
+    "sinon": "^14.0.0"
+  },
+  "files": [
+    "/bin",
+    "/dist",
+    "/oclif.manifest.json",
+    "/npm-shrinkwrap.json"
+  ],
+  "keywords": [
+    "zcli",
+    "zendesk",
+    "cli",
+    "command"
+  ],
+  "license": "MIT",
+  "main": "src/index.js",
+  "oclif": {
+    "commands": "./src/commands",
+    "bin": "zcli-connectors"
+  },
+  "types": "lib/index.d.ts"
+}

packages/zcli-connectors/src/commands/connectors/bundle.ts

@@ -0,0 +1,27 @@
+import { Command } from '@oclif/core'
+import * as path from 'path'
+import * as chalk from 'chalk'
+
+export default class Bundle extends Command {
+  static description = 'bundles your connector package (Note: This command is not yet available for customers)'
+
+  static args = [
+    { name: 'connectorDirectory', default: '.', description: 'connector path where configuration exists' }
+  ]
+
+  static examples = [
+    '$ zcli connectors:bundle .',
+    '$ zcli connectors:bundle ./connector1'
+  ]
+
+  async run () {
+    const { args } = await this.parse(Bundle)
+    const { connectorDirectory } = args
+
+    const connectorPath = path.resolve(connectorDirectory)
+
+    this.log(chalk.yellow(`Bundling connector from: ${connectorPath}`))
+    // Placeholder for actual bundling logic
+    this.log(chalk.green('Connector bundle created successfully!'))
+  }
+}

packages/zcli-connectors/src/constants.ts

@@ -0,0 +1 @@
+export const DEFAULT_CONNECTORS_CONFIG_FILE = 'zcli.connectors.config.json'

packages/zcli-connectors/src/index.js

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

packages/zcli-connectors/src/types.ts

@@ -0,0 +1,21 @@
+export interface ConfigParameters {
+  [parameterKey: string]: string | number | boolean;
+}
+
+export interface ZcliConfigFileContent {
+    connection_id?: string;
+    parameters?: ConfigParameters;
+}
+
+export type Dictionary<T> = {
+    [key: string]: T;
+}
+
+export interface FileList {
+    name: string;
+    time: number;
+}
+
+export interface FsExtraError extends Error {
+    code: string;
+}

packages/zcli-connectors/tests/functional/bundle.test.ts

@@ -0,0 +1,20 @@
+import { test } from '@oclif/test'
+import BundleCommand from '../../src/commands/connectors/bundle'
+
+describe('bundle', () => {
+  describe('with default directory', () => {
+    test
+      .it('should run bundle command with default directory', async () => {
+        await BundleCommand.run(['.'])
+        // Test passes if no error is thrown
+      })
+  })
+
+  describe('with custom directory', () => {
+    test
+      .it('should run bundle command with custom directory', async () => {
+        await BundleCommand.run(['./custom'])
+        // Test passes if no error is thrown
+      })
+  })
+})

packages/zcli-connectors/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "importHelpers": true,
+    "module": "commonjs",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "target": "es2017",
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  },
+  "include": [
+    "src/**/*"
+  ]
+}