@calltelemetry/cli 0.15.1 → 1.1.0

package/dist/lib/sftp.d.ts

@@ -0,0 +1,231 @@
+/**
+ * SFTP Action Account domain helpers.
+ *
+ * Paths and response envelopes here match the appliance OpenAPI contract
+ * (`sftp_action_accounts`, `sftp_monitoring`, `sftp_storage`, ...). Every
+ * command checks the live spec first so a missing route on an older release
+ * produces an actionable message instead of a raw 404.
+ */
+import { ApplianceApi } from './appliance-api.js';
+import { type OpenApiDocument, type ResolvedOperation } from './openapi.js';
+export interface SftpAction {
+    type: string;
+    target?: string | null;
+    params?: Record<string, unknown> | null;
+}
+export interface SftpAccount {
+    id: number;
+    org_id: number;
+    username: string;
+    enabled: boolean;
+    home?: string;
+    description?: string | null;
+    on_success_actions?: SftpAction[] | null;
+    on_failure_actions?: SftpAction[] | null;
+    quota_used_bytes?: number | null;
+    quota_limit_gb?: number | string | null;
+    last_quota_calculated_at?: string | null;
+    upload_monitoring_enabled?: boolean;
+    expected_schedule?: string | null;
+    expected_next_upload_at?: string | null;
+    last_upload_at?: string | null;
+    missed_upload_count?: number;
+    alert_on_missed_uploads?: boolean;
+    inserted_at?: string;
+    updated_at?: string;
+    [key: string]: unknown;
+}
+export interface SftpQuota {
+    quota_used_bytes?: number | null;
+    quota_limit_gb?: number | string | null;
+    quota_percentage?: number | null;
+    over_quota?: boolean;
+    last_calculated_at?: string | null;
+}
+export interface SftpStorageStatus {
+    total_used_bytes?: number;
+    total_limit_gb?: number | string | null;
+    account_count?: number;
+    accounts_over_quota?: number;
+}
+export interface SftpRun {
+    id: number;
+    action_account_id?: number;
+    username?: string;
+    status?: string;
+    type?: string;
+    event?: string;
+    file?: string | null;
+    result?: unknown;
+    inserted_at?: string;
+    updated_at?: string;
+}
+export interface SftpActivity {
+    id: number;
+    action?: string;
+    status?: string;
+    actor_ip?: string | null;
+    target_type?: string | null;
+    target_id?: string | null;
+    error_message?: string | null;
+    metadata?: Record<string, unknown> | null;
+    inserted_at?: string;
+}
+export interface SftpFileEntry {
+    name: string;
+    path: string;
+    type: 'file' | 'directory' | string;
+    size?: number | null;
+    modified_at?: string | null;
+}
+export interface SftpMonitoringConfig {
+    enabled?: boolean;
+    schedule?: {
+        type?: string;
+        hour?: number | null;
+        minute?: number | null;
+        day_of_week?: number | null;
+        day_of_month?: number | null;
+        weekdays_only?: boolean;
+    };
+    config?: {
+        alert_on_missed_uploads?: boolean;
+        tolerance_minutes?: number;
+        alert_threshold?: number;
+        alert_config?: Record<string, unknown>;
+    };
+    expected_next_upload_at?: string | null;
+    last_upload_at?: string | null;
+    missed_upload_count?: number;
+}
+export interface SftpMonitoredAccount {
+    id: number;
+    org_id?: number;
+    username: string;
+    enabled?: boolean;
+    monitoring?: SftpMonitoringConfig;
+}
+export interface SftpContact {
+    id: number;
+    name?: string;
+    email?: string;
+    phone?: string;
+    [key: string]: unknown;
+}
+export interface SftpReportSchedule {
+    id: number;
+    enabled?: boolean;
+    schedule_type?: string;
+    next_run_at?: string | null;
+    last_run_at?: string | null;
+    last_run_status?: string | null;
+    last_run_error?: string | null;
+    failure_count?: number;
+    [key: string]: unknown;
+}
+/** Assert the installed release exposes an operation, with a release-aware error. */
+export declare function requireOperation(spec: OpenApiDocument, ref: string): ResolvedOperation;
+export declare function supportsOperation(spec: OpenApiDocument, ref: string): boolean;
+export declare const ACCOUNT_USERNAME_PATTERN: RegExp;
+export declare function validateUsername(username: string): void;
+export declare function generateSftpPassword(length?: number): string;
+export declare function parseQuotaGb(value: string | undefined): number | null | undefined;
+/**
+ * Parse repeated `--on-success` / `--on-failure` values.
+ * Accepts a bare action type, an inline JSON object, or `@file` containing a
+ * JSON object or array of objects.
+ */
+export declare function parseActionOptions(values: string[] | undefined): SftpAction[] | undefined;
+export interface CreateAccountInput {
+    username: string;
+    password?: string;
+    generatePassword?: boolean;
+    description?: string;
+    enabled?: boolean;
+    quotaGb?: string;
+    callmanagerId?: string;
+    onSuccess: string[];
+    onFailure: string[];
+}
+export interface AccountPayloadResult {
+    account: Record<string, unknown>;
+    generatedPassword?: string;
+}
+export declare function buildCreateAccountPayload(input: CreateAccountInput): AccountPayloadResult;
+export interface UpdateAccountInput {
+    description?: string;
+    quotaGb?: string;
+    callmanagerId?: string;
+    enable?: boolean;
+    disable?: boolean;
+    password?: string;
+    generatePassword?: boolean;
+    onSuccess: string[];
+    onFailure: string[];
+    clearSuccess?: boolean;
+    clearFailure?: boolean;
+}
+export declare function buildUpdateAccountPayload(input: UpdateAccountInput): AccountPayloadResult;
+export declare function listAccounts(api: ApplianceApi): Promise<SftpAccount[]>;
+export declare function resolveAccount(api: ApplianceApi, ref: string): Promise<SftpAccount>;
+export declare function getAccountQuota(api: ApplianceApi, account: SftpAccount): Promise<SftpQuota>;
+export declare function getAccountRuns(api: ApplianceApi, account: SftpAccount, limit?: number, offset?: number): Promise<SftpRun[]>;
+export declare function getAccountActivity(api: ApplianceApi, account: SftpAccount, limit?: number, offset?: number): Promise<SftpActivity[]>;
+export declare function getAccountFiles(api: ApplianceApi, account: SftpAccount, path?: string, limit?: number): Promise<{
+    path?: string;
+    total?: number;
+    entries: SftpFileEntry[];
+}>;
+export declare function getAccountContacts(api: ApplianceApi, account: SftpAccount): Promise<SftpContact[]>;
+export declare function addAccountContacts(api: ApplianceApi, account: SftpAccount, contactIds: number[]): Promise<unknown>;
+export declare function removeAccountContact(api: ApplianceApi, account: SftpAccount, contactId: number): Promise<unknown>;
+export interface MonitoringInput {
+    schedule?: string;
+    hour?: string;
+    minute?: string;
+    dayOfWeek?: string;
+    dayOfMonth?: string;
+    weekdaysOnly?: boolean;
+    tolerance?: string;
+    threshold?: string;
+    alertOnMissed?: boolean;
+    alertConfig?: string;
+}
+export declare function buildMonitoringPayload(input: MonitoringInput, requireSchedule: boolean): Record<string, unknown>;
+export declare function listMonitoredAccounts(api: ApplianceApi): Promise<SftpMonitoredAccount[]>;
+export declare function getAccountMonitoring(api: ApplianceApi, account: SftpAccount): Promise<SftpMonitoringConfig>;
+export interface DiscoverMonitoringInput {
+    host?: string;
+    username?: string;
+    password?: string;
+    scheduleName?: string;
+    callmanagerId?: string;
+    tolerance?: string;
+}
+export declare function buildDiscoverPayload(input: DiscoverMonitoringInput): Record<string, unknown>;
+export interface SftpStatusSnapshot {
+    accounts: {
+        total: number;
+        enabled: number;
+        disabled: number;
+    };
+    storage: SftpStorageStatus | null;
+    monitoring: {
+        available: boolean;
+        monitoredCount: number;
+        missingUploads: number | null;
+    };
+    operations: {
+        total: number;
+        specOpenApi: string | null;
+    };
+}
+export declare function collectSftpStatus(api: ApplianceApi, spec: OpenApiDocument): Promise<SftpStatusSnapshot>;
+/** Read a CSV or JSON file for import. */
+export declare function readImportFile(path: string): {
+    filename: string;
+    data: Buffer;
+    contentType: string;
+};
+export declare function parseContactIds(values: string[] | undefined): number[];
+//# sourceMappingURL=sftp.d.ts.map

package/dist/lib/sftp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sftp.d.ts","sourceRoot":"","sources":["../../src/lib/sftp.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,EAAE,YAAY,EAAuD,MAAM,oBAAoB,CAAC;AACvG,OAAO,EAIL,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACvB,MAAM,cAAc,CAAC;AAEtB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACzC;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,kBAAkB,CAAC,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACzC,kBAAkB,CAAC,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACxC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACxB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACxC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,iBAAiB;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACxC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;IACpC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;IACF,MAAM,CAAC,EAAE;QACP,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACxC,CAAC;IACF,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAmCD,qFAAqF;AACrF,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,eAAe,EAAE,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAUtF;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,eAAe,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAE7E;AAID,eAAO,MAAM,wBAAwB,QAA4B,CAAC;AAElE,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAMvD;AAED,wBAAgB,oBAAoB,CAAC,MAAM,SAAK,GAAG,MAAM,CAIxD;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAajF;AAwBD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,UAAU,EAAE,GAAG,SAAS,CAsBzF;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,kBAAkB,GAAG,oBAAoB,CA2CzF;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,kBAAkB,GAAG,oBAAoB,CAuDzF;AAED,wBAAsB,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAG5E;AAED,wBAAsB,cAAc,CAAC,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CA2BzF;AAED,wBAAsB,eAAe,CAAC,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CAGjG;AAED,wBAAsB,cAAc,CAAC,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAKxH;AAED,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,WAAW,EACpB,KAAK,SAAM,EACX,MAAM,SAAI,GACT,OAAO,CAAC,YAAY,EAAE,CAAC,CAKzB;AAED,wBAAsB,eAAe,CACnC,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,WAAW,EACpB,IAAI,CAAC,EAAE,MAAM,EACb,KAAK,SAAM,GACV,OAAO,CAAC;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC,CAUtE;AAED,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAGxG;AAED,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,WAAW,EACpB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,OAAO,CAAC,CAKlB;AAED,wBAAsB,oBAAoB,CACxC,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,WAAW,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC,CAKlB;AAID,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAWD,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAoDhH;AAED,wBAAsB,qBAAqB,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAG9F;AAED,wBAAsB,oBAAoB,CACxC,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC,oBAAoB,CAAC,CAG/B;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CA2B5F;AAID,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE;QACR,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAClC,UAAU,EAAE;QACV,SAAS,EAAE,OAAO,CAAC;QACnB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B,CAAC;IACF,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B,CAAC;CACH;AAED,wBAAsB,iBAAiB,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAqD7G;AAED,0CAA0C;AAC1C,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAKpG;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,CAkBtE"}

package/dist/lib/sftp.js

@@ -0,0 +1,439 @@
+/**
+ * SFTP Action Account domain helpers.
+ *
+ * Paths and response envelopes here match the appliance OpenAPI contract
+ * (`sftp_action_accounts`, `sftp_monitoring`, `sftp_storage`, ...). Every
+ * command checks the live spec first so a missing route on an older release
+ * produces an actionable message instead of a raw 404.
+ */
+import { randomBytes } from 'node:crypto';
+import { readFileSync } from 'node:fs';
+import { ApplianceApiError, parsePositiveInt, readJsonOption } from './appliance-api.js';
+import { getOperation, hasOperation, listOperations, } from './openapi.js';
+function asRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value)
+        ? value
+        : {};
+}
+function unwrapList(data, ...keys) {
+    if (Array.isArray(data))
+        return data;
+    const record = asRecord(data);
+    for (const key of keys) {
+        if (Array.isArray(record[key]))
+            return record[key];
+    }
+    const nested = asRecord(record.data);
+    for (const key of keys) {
+        if (Array.isArray(nested[key]))
+            return nested[key];
+    }
+    if (Array.isArray(record.data))
+        return record.data;
+    return [];
+}
+function unwrapRecord(data, key) {
+    const record = asRecord(data);
+    if (record[key] !== undefined && record[key] !== null)
+        return record[key];
+    const nested = asRecord(record.data);
+    if (nested[key] !== undefined && nested[key] !== null)
+        return nested[key];
+    return (record[key] ?? record.data ?? data);
+}
+/** Assert the installed release exposes an operation, with a release-aware error. */
+export function requireOperation(spec, ref) {
+    try {
+        return getOperation(spec, ref);
+    }
+    catch (err) {
+        throw new ApplianceApiError(`This appliance release does not expose the SFTP operation "${ref}". ` +
+            `Run "ct sftp api --list" to see the operations this release supports.`, { code: 'UNSUPPORTED_OPERATION', body: err.message });
+    }
+}
+export function supportsOperation(spec, ref) {
+    return hasOperation(spec, ref);
+}
+// ── Accounts ─────────────────────────────────────────────────────────────
+export const ACCOUNT_USERNAME_PATTERN = /^[A-Za-z0-9_.@-]{3,50}$/;
+export function validateUsername(username) {
+    if (!ACCOUNT_USERNAME_PATTERN.test(username)) {
+        throw new ApplianceApiError('Username must be 3–50 characters and contain only letters, numbers, dots, underscores, hyphens, or @.');
+    }
+}
+export function generateSftpPassword(length = 24) {
+    return randomBytes(Math.max(18, Math.ceil(length * 0.75)))
+        .toString('base64url')
+        .slice(0, length);
+}
+export function parseQuotaGb(value) {
+    if (value === undefined)
+        return undefined;
+    const trimmed = value.trim().toLowerCase();
+    if (trimmed === 'none' || trimmed === 'default' || trimmed === 'unlimited')
+        return null;
+    const parsed = Number(trimmed);
+    if (!Number.isFinite(parsed) || parsed <= 0) {
+        throw new ApplianceApiError('Quota must be a positive number of GB, or "none" to use the organization default.');
+    }
+    if (parsed > 10_000) {
+        throw new ApplianceApiError('Quota must be 10,000 GB (10 TB) or less.');
+    }
+    return parsed;
+}
+function validateAction(action, label) {
+    const record = asRecord(action);
+    const type = record.type;
+    if (typeof type !== 'string' || !/^[a-z0-9_]+$/.test(type)) {
+        throw new ApplianceApiError(`${label} must include a valid "type" (lowercase letters, numbers, underscores).`);
+    }
+    const params = record.params;
+    if (params !== undefined && params !== null && (typeof params !== 'object' || Array.isArray(params))) {
+        throw new ApplianceApiError(`${label} "params" must be a JSON object.`);
+    }
+    return {
+        type,
+        target: typeof record.target === 'string' ? record.target : null,
+        params: params ?? null,
+    };
+}
+/**
+ * Parse repeated `--on-success` / `--on-failure` values.
+ * Accepts a bare action type, an inline JSON object, or `@file` containing a
+ * JSON object or array of objects.
+ */
+export function parseActionOptions(values) {
+    if (!values || values.length === 0)
+        return undefined;
+    const actions = [];
+    for (const raw of values) {
+        const value = raw.trim();
+        if (!value)
+            continue;
+        if (value.startsWith('@') || value.startsWith('{') || value.startsWith('[')) {
+            const parsed = readJsonOption(value, 'actions');
+            const list = Array.isArray(parsed) ? parsed : [parsed];
+            for (const item of list) {
+                actions.push(validateAction(item, 'Action'));
+            }
+            continue;
+        }
+        actions.push(validateAction({ type: value }, 'Action'));
+    }
+    return actions;
+}
+export function buildCreateAccountPayload(input) {
+    validateUsername(input.username);
+    const payload = {
+        username: input.username,
+    };
+    let generatedPassword;
+    let password = input.password;
+    if (!password && input.generatePassword !== false) {
+        generatedPassword = generateSftpPassword();
+        password = generatedPassword;
+    }
+    if (!password) {
+        throw new ApplianceApiError('A password is required. Pass --password, --password-stdin, or use --generate.');
+    }
+    if (password.length < 8 || password.length > 128) {
+        throw new ApplianceApiError('Password must be between 8 and 128 characters.');
+    }
+    payload.password = password;
+    if (input.description !== undefined)
+        payload.description = input.description;
+    if (input.enabled !== undefined)
+        payload.enabled = input.enabled;
+    const quota = parseQuotaGb(input.quotaGb);
+    if (quota !== undefined)
+        payload.quota_limit_gb = quota;
+    const callmanagerId = parsePositiveInt(input.callmanagerId, '--callmanager-id');
+    if (callmanagerId !== undefined)
+        payload.callmanager_id = callmanagerId;
+    const onSuccess = parseActionOptions(input.onSuccess);
+    if (onSuccess)
+        payload.on_success_actions = onSuccess;
+    const onFailure = parseActionOptions(input.onFailure);
+    if (onFailure)
+        payload.on_failure_actions = onFailure;
+    return { account: payload, generatedPassword };
+}
+export function buildUpdateAccountPayload(input) {
+    if (input.enable && input.disable) {
+        throw new ApplianceApiError('Use either --enable or --disable, not both.');
+    }
+    if (input.password && input.generatePassword) {
+        throw new ApplianceApiError('Use either --password/--password-stdin or --generate, not both.');
+    }
+    if (input.clearSuccess && input.onSuccess.length > 0) {
+        throw new ApplianceApiError('Use either --on-success or --clear-success-actions, not both.');
+    }
+    if (input.clearFailure && input.onFailure.length > 0) {
+        throw new ApplianceApiError('Use either --on-failure or --clear-failure-actions, not both.');
+    }
+    const payload = {};
+    let generatedPassword;
+    if (input.description !== undefined)
+        payload.description = input.description;
+    const quota = parseQuotaGb(input.quotaGb);
+    if (quota !== undefined)
+        payload.quota_limit_gb = quota;
+    const callmanagerId = parsePositiveInt(input.callmanagerId, '--callmanager-id');
+    if (callmanagerId !== undefined)
+        payload.callmanager_id = callmanagerId;
+    if (input.enable)
+        payload.enabled = true;
+    if (input.disable)
+        payload.enabled = false;
+    if (input.password !== undefined && input.password !== '') {
+        if (input.password.length < 8 || input.password.length > 128) {
+            throw new ApplianceApiError('Password must be between 8 and 128 characters.');
+        }
+        payload.password = input.password;
+    }
+    else if (input.generatePassword) {
+        generatedPassword = generateSftpPassword();
+        payload.password = generatedPassword;
+    }
+    const onSuccess = parseActionOptions(input.onSuccess);
+    if (input.clearSuccess)
+        payload.on_success_actions = [];
+    else if (onSuccess)
+        payload.on_success_actions = onSuccess;
+    const onFailure = parseActionOptions(input.onFailure);
+    if (input.clearFailure)
+        payload.on_failure_actions = [];
+    else if (onFailure)
+        payload.on_failure_actions = onFailure;
+    if (Object.keys(payload).length === 0) {
+        throw new ApplianceApiError('Nothing to update. Pass --description, --quota-gb, --enable/--disable, ' +
+            '--password/--generate, or an action option.');
+    }
+    return { account: payload, generatedPassword };
+}
+export async function listAccounts(api) {
+    const response = await api.get('sftp_action_accounts');
+    return unwrapList(response.data, 'accounts', 'data');
+}
+export async function resolveAccount(api, ref) {
+    const trimmed = ref.trim();
+    if (!trimmed)
+        throw new ApplianceApiError('Account ID or username is required');
+    if (/^\d+$/.test(trimmed)) {
+        const response = await api.get(`sftp_action_accounts/${trimmed}`);
+        return unwrapRecord(response.data, 'account');
+    }
+    const accounts = await listAccounts(api);
+    const exact = accounts.find(account => account.username === trimmed);
+    if (exact)
+        return exact;
+    const caseInsensitive = accounts.find(account => account.username.toLowerCase() === trimmed.toLowerCase());
+    if (caseInsensitive)
+        return caseInsensitive;
+    const suggestions = accounts
+        .filter(account => account.username.toLowerCase().includes(trimmed.toLowerCase()))
+        .slice(0, 5)
+        .map(account => account.username);
+    throw new ApplianceApiError(`SFTP account "${trimmed}" was not found.` +
+        (suggestions.length > 0 ? ` Similar accounts: ${suggestions.join(', ')}.` : ''));
+}
+export async function getAccountQuota(api, account) {
+    const response = await api.get(`sftp_action_accounts/${account.id}/quota`);
+    return unwrapRecord(response.data, 'quota');
+}
+export async function getAccountRuns(api, account, limit = 50, offset = 0) {
+    const response = await api.get(`sftp_action_accounts/${account.id}/runs`, {
+        query: { limit, offset },
+    });
+    return unwrapList(response.data, 'runs', 'data');
+}
+export async function getAccountActivity(api, account, limit = 100, offset = 0) {
+    const response = await api.get(`sftp_action_accounts/${account.id}/activity`, {
+        query: { limit, offset },
+    });
+    return unwrapList(response.data, 'activity', 'data');
+}
+export async function getAccountFiles(api, account, path, limit = 200) {
+    const response = await api.get(`sftp_action_accounts/${account.id}/files`, {
+        query: { path, limit },
+    });
+    const record = asRecord(response.data);
+    return {
+        path: typeof record.path === 'string' ? record.path : path,
+        total: typeof record.total === 'number' ? record.total : undefined,
+        entries: unwrapList(response.data, 'entries', 'data'),
+    };
+}
+export async function getAccountContacts(api, account) {
+    const response = await api.get(`sftp_action_accounts/${account.id}/contacts`);
+    return unwrapList(response.data, 'contacts', 'data');
+}
+export async function addAccountContacts(api, account, contactIds) {
+    const response = await api.post(`sftp_action_accounts/${account.id}/contacts`, {
+        contact_ids: contactIds,
+    });
+    return response.data;
+}
+export async function removeAccountContact(api, account, contactId) {
+    const response = await api.delete(`sftp_action_accounts/${account.id}/contacts/${contactId}`);
+    return response.data;
+}
+function optionalInt(value, label, min, max) {
+    if (value === undefined || value === '')
+        return undefined;
+    const parsed = Number(value);
+    if (!Number.isInteger(parsed) || parsed < min || parsed > max) {
+        throw new ApplianceApiError(`${label} must be an integer between ${min} and ${max}.`);
+    }
+    return parsed;
+}
+export function buildMonitoringPayload(input, requireSchedule) {
+    const payload = {};
+    if (requireSchedule && !input.schedule) {
+        throw new ApplianceApiError('--schedule is required (hourly, daily, weekly, or monthly).');
+    }
+    if (input.schedule !== undefined) {
+        const schedule = input.schedule.toLowerCase();
+        if (!['hourly', 'daily', 'weekly', 'monthly'].includes(schedule)) {
+            throw new ApplianceApiError('--schedule must be one of: hourly, daily, weekly, monthly.');
+        }
+        payload.expected_schedule = schedule;
+    }
+    const hour = optionalInt(input.hour, '--hour', 0, 23);
+    if (hour !== undefined)
+        payload.expected_hour = hour;
+    const minute = optionalInt(input.minute, '--minute', 0, 59);
+    if (minute !== undefined)
+        payload.expected_minute = minute;
+    const dayOfWeek = optionalInt(input.dayOfWeek, '--day-of-week', 1, 7);
+    if (dayOfWeek !== undefined)
+        payload.expected_day_of_week = dayOfWeek;
+    const dayOfMonth = optionalInt(input.dayOfMonth, '--day-of-month', 1, 28);
+    if (dayOfMonth !== undefined)
+        payload.expected_day_of_month = dayOfMonth;
+    const tolerance = optionalInt(input.tolerance, '--tolerance', 1, 10080);
+    if (tolerance !== undefined)
+        payload.tolerance_minutes = tolerance;
+    const threshold = optionalInt(input.threshold, '--threshold', 1, 99);
+    if (threshold !== undefined)
+        payload.alert_threshold = threshold;
+    if (input.weekdaysOnly !== undefined)
+        payload.weekdays_only = input.weekdaysOnly;
+    if (input.alertOnMissed !== undefined)
+        payload.alert_on_missed_uploads = input.alertOnMissed;
+    if (input.alertConfig !== undefined) {
+        const parsed = readJsonOption(input.alertConfig, '--alert-config');
+        if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) {
+            throw new ApplianceApiError('--alert-config must be a JSON object.');
+        }
+        payload.alert_config = parsed;
+    }
+    if (payload.expected_schedule === 'weekly' && payload.expected_day_of_week === undefined) {
+        throw new ApplianceApiError('--day-of-week is required for a weekly schedule.');
+    }
+    if (payload.expected_schedule === 'monthly' && payload.expected_day_of_month === undefined) {
+        throw new ApplianceApiError('--day-of-month is required for a monthly schedule.');
+    }
+    return payload;
+}
+export async function listMonitoredAccounts(api) {
+    const response = await api.get('sftp_monitoring');
+    return unwrapList(response.data, 'data', 'accounts');
+}
+export async function getAccountMonitoring(api, account) {
+    const response = await api.get(`sftp_action_accounts/${account.id}/monitoring`);
+    return unwrapRecord(response.data, 'monitoring');
+}
+export function buildDiscoverPayload(input) {
+    const payload = {};
+    if (input.scheduleName !== undefined)
+        payload.schedule_name = input.scheduleName;
+    if (input.host !== undefined)
+        payload.host = input.host;
+    if (input.username !== undefined)
+        payload.username = input.username;
+    if (input.password !== undefined)
+        payload.password = input.password;
+    const callmanagerId = optionalInt(input.callmanagerId, '--callmanager-id', 1, Number.MAX_SAFE_INTEGER);
+    if (callmanagerId !== undefined)
+        payload.callmanager_id = callmanagerId;
+    const tolerance = optionalInt(input.tolerance, '--tolerance', 1, 10080);
+    if (tolerance !== undefined)
+        payload.tolerance_minutes = tolerance;
+    if ((payload.host || payload.username) && !payload.password && payload.callmanager_id === undefined) {
+        throw new ApplianceApiError('CUCM discovery needs --password/--password-stdin, or use --callmanager-id with stored credentials.');
+    }
+    if (Object.keys(payload).length === 0) {
+        throw new ApplianceApiError('Pass discovery credentials (--host, --username, --password) or --callmanager-id.');
+    }
+    return payload;
+}
+export async function collectSftpStatus(api, spec) {
+    const accountsPromise = supportsOperation(spec, 'GET sftp_action_accounts')
+        ? listAccounts(api)
+        : Promise.resolve([]);
+    const storagePromise = supportsOperation(spec, 'GET sftp_storage/status')
+        ? api
+            .get('sftp_storage/status')
+            .then(response => unwrapRecord(response.data, 'storage'))
+            .catch(() => null)
+        : Promise.resolve(null);
+    const monitoringPromise = supportsOperation(spec, 'GET sftp_monitoring')
+        ? listMonitoredAccounts(api).catch(() => [])
+        : Promise.resolve([]);
+    const missingPromise = supportsOperation(spec, 'GET sftp_monitoring/missing')
+        ? api
+            .get('sftp_monitoring/missing')
+            .then(response => unwrapList(response.data, 'accounts', 'data').length)
+            .catch(() => null)
+        : Promise.resolve(null);
+    const [accounts, storage, monitored, missingUploads] = await Promise.all([
+        accountsPromise,
+        storagePromise,
+        monitoringPromise,
+        missingPromise,
+    ]);
+    const enabled = accounts.filter(account => account.enabled).length;
+    const sftpOperations = listOperations(spec, { contains: 'sftp' }).length;
+    return {
+        accounts: {
+            total: accounts.length,
+            enabled,
+            disabled: accounts.length - enabled,
+        },
+        storage,
+        monitoring: {
+            available: supportsOperation(spec, 'GET sftp_monitoring'),
+            monitoredCount: monitored.filter(account => account.monitoring?.enabled).length,
+            missingUploads,
+        },
+        operations: {
+            total: sftpOperations,
+            specOpenApi: spec.openapi ?? null,
+        },
+    };
+}
+/** Read a CSV or JSON file for import. */
+export function readImportFile(path) {
+    const data = readFileSync(path);
+    const filename = path.split(/[\\/]/).pop() ?? 'import.csv';
+    const contentType = filename.toLowerCase().endsWith('.json') ? 'application/json' : 'text/csv';
+    return { filename, data, contentType };
+}
+export function parseContactIds(values) {
+    if (!values || values.length === 0) {
+        throw new ApplianceApiError('At least one --contact <id> is required.');
+    }
+    return values.flatMap(value => value
+        .split(',')
+        .map(part => part.trim())
+        .filter(Boolean)
+        .map(part => {
+        const id = Number(part);
+        if (!Number.isInteger(id) || id <= 0) {
+            throw new ApplianceApiError(`Invalid contact ID: ${part}`);
+        }
+        return id;
+    }));
+}
+//# sourceMappingURL=sftp.js.map