dbdiagram 0.1.2 → 0.3.0

package/dist/program.js

@@ -9,8 +9,9 @@ export function createProgram() {
         .helpOption('-h, --help', 'Show help information')
         .enablePositionalOptions(true)
         .action(() => {
-        program.help();
+        program.outputHelp();
     })
         .showHelpAfterError(true);
+    program.exitOverride();
     return program;
 }

package/dist/services/telemetry.service.js

@@ -0,0 +1,59 @@
+import crypto from 'node:crypto';
+import fs from 'node:fs';
+import packageJson from '../../package.json' with { type: 'json' };
+import { telemetryIntegration } from '../integrations/telemetry/telemetry.integration.js';
+import { detectAgent } from '../utils/agent-detector.util.js';
+import { detectExecuteEnvironment } from '../utils/environment-detector.util.js';
+import { getGlobalDir, getTelemetryFilePath, readAndParseJsonFileSafe } from '../utils/file.util.js';
+const events = [];
+let deviceId;
+let invocationId;
+export const getOrCreateDeviceId = () => {
+    const telemetryFilePath = getTelemetryFilePath();
+    const telemetrySettings = readAndParseJsonFileSafe(telemetryFilePath);
+    if (telemetrySettings && telemetrySettings.deviceId) {
+        return telemetrySettings.deviceId;
+    }
+    const deviceId = crypto.randomUUID();
+    fs.mkdirSync(getGlobalDir(), { recursive: true });
+    fs.writeFileSync(telemetryFilePath, JSON.stringify({ deviceId }, null, 2));
+    return deviceId;
+};
+export const constructCliClientContext = () => {
+    const { actor, agentName } = detectAgent();
+    return {
+        deviceId: deviceId ?? '',
+        invocationId: invocationId ?? '',
+        cliVersion: packageJson.version,
+        nodeVersion: process.versions.node,
+        os: process.platform,
+        arch: process.arch,
+        actor,
+        ...(agentName ? { agentName } : {}),
+        environment: detectExecuteEnvironment(),
+    };
+};
+export const initTelemetry = () => {
+    try {
+        deviceId = getOrCreateDeviceId();
+        invocationId = crypto.randomUUID();
+    }
+    catch {
+    }
+};
+export const trackEvent = (event) => {
+    try {
+        events.push({ ...event, timestamp: Date.now() });
+    }
+    catch {
+    }
+};
+export const flushTelemetry = () => {
+    try {
+        if (!events.length)
+            return;
+        telemetryIntegration.send(events, constructCliClientContext());
+    }
+    catch {
+    }
+};

package/dist/types/telemetry.type.js

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

package/dist/utils/agent-detector.util.js

@@ -0,0 +1,27 @@
+const AGENT_ENV_VAR_TO_NAME = {
+    CURSOR_TRACE_ID: 'cursor',
+    CURSOR_AGENT: 'cursor-cli',
+    CURSOR_EXTENSION_HOST_ROLE: 'cursor-cli',
+    GEMINI_CLI: 'gemini',
+    CODEX_SANDBOX: 'codex',
+    CODEX_CI: 'codex',
+    CODEX_THREAD_ID: 'codex',
+    CLAUDECODE: 'claude',
+    CLAUDE_CODE: 'claude',
+    REPL_ID: 'replit',
+    COPILOT_MODEL: 'github-copilot',
+    COPILOT_ALLOW_ALL: 'github-copilot',
+    COPILOT_GITHUB_TOKEN: 'github-copilot',
+    ANTIGRAVITY_AGENT: 'antigravity',
+    AUGMENT_AGENT: 'augment-cli',
+    OPENCODE_CLIENT: 'opencode',
+    OPENCODE: 'opencode',
+};
+export const detectAgent = () => {
+    for (const [envVar, agentName] of Object.entries(AGENT_ENV_VAR_TO_NAME)) {
+        if (process.env[envVar]) {
+            return { actor: 'ai_agent', agentName };
+        }
+    }
+    return { actor: 'human' };
+};

package/dist/utils/cli-error.util.js

@@ -0,0 +1,46 @@
+import { CliError } from '../errors/cli.error.js';
+import { CLI_ERROR_MESSAGES, PORTAL_TO_CLI_CODE, REAUTH_MESSAGE, AUTH_INVALID_CREDENTIALS, AUTH_LOGIN_TIMEOUT, AUTH_LOGIN_CANCELLED, AUTH_LOGIN_STATE_MISMATCH, AUTH_LOGIN_INVALID_CALLBACK, AUTH_LOGIN_EXCHANGE_FAILED, AUTH_LOGIN_SERVER_ERROR, AUTH_LOGIN_FAILED, VALIDATION_FAILED, UNEXPECTED_ERROR, } from '../constants/cli-error.constant.js';
+import { PortalApiError } from '../errors/portal-api.error.js';
+import { PortalAuthenticationError, PORTAL_AUTH_ERROR_CODES } from '../libs/portal/index.js';
+export function isPortalApiError(error) {
+    return error instanceof PortalApiError;
+}
+export const getCliErrorMessageFromCode = (errorCode) => {
+    return CLI_ERROR_MESSAGES[errorCode] ?? `An unexpected error occurred [${errorCode}]`;
+};
+export const fromPortalError = (error) => {
+    if (error.errorCode.startsWith('auth_')) {
+        return new CliError(AUTH_INVALID_CREDENTIALS, REAUTH_MESSAGE);
+    }
+    if (error.errorCode === 'validation_invalid_payload') {
+        return new CliError(VALIDATION_FAILED, error.message);
+    }
+    const mappedCliErrorCode = PORTAL_TO_CLI_CODE[error.errorCode];
+    if (mappedCliErrorCode) {
+        return new CliError(mappedCliErrorCode, getCliErrorMessageFromCode(mappedCliErrorCode));
+    }
+    return new CliError(UNEXPECTED_ERROR, `An unexpected error occurred [${error.errorCode}]`);
+};
+const PORTAL_AUTH_TO_CLI_CODE = {
+    [PORTAL_AUTH_ERROR_CODES.loginTimeout]: AUTH_LOGIN_TIMEOUT,
+    [PORTAL_AUTH_ERROR_CODES.loginCancelled]: AUTH_LOGIN_CANCELLED,
+    [PORTAL_AUTH_ERROR_CODES.stateMismatch]: AUTH_LOGIN_STATE_MISMATCH,
+    [PORTAL_AUTH_ERROR_CODES.invalidCallback]: AUTH_LOGIN_INVALID_CALLBACK,
+    [PORTAL_AUTH_ERROR_CODES.exchangeFailed]: AUTH_LOGIN_EXCHANGE_FAILED,
+    [PORTAL_AUTH_ERROR_CODES.loopbackServerError]: AUTH_LOGIN_SERVER_ERROR,
+    [PORTAL_AUTH_ERROR_CODES.unknownError]: AUTH_LOGIN_FAILED,
+};
+export const fromPortalAuthError = (error) => {
+    const cliCode = PORTAL_AUTH_TO_CLI_CODE[error.errorCode] ?? AUTH_LOGIN_FAILED;
+    return new CliError(cliCode, getCliErrorMessageFromCode(cliCode));
+};
+export const toCliError = (error) => {
+    if (error instanceof CliError)
+        return error;
+    if (error instanceof PortalAuthenticationError)
+        return fromPortalAuthError(error);
+    if (isPortalApiError(error))
+        return fromPortalError(error);
+    const message = error instanceof Error ? error.message : String(error);
+    return new CliError(UNEXPECTED_ERROR, message);
+};

package/dist/utils/command-name.util.js

@@ -0,0 +1,12 @@
+export function resolveCommandName(actionCommand) {
+    const nameSegments = [];
+    let currentCommand = actionCommand;
+    while (currentCommand && currentCommand.parent) {
+        nameSegments.unshift(currentCommand.name());
+        currentCommand = currentCommand.parent;
+    }
+    if (nameSegments.length === 0) {
+        return actionCommand.name();
+    }
+    return nameSegments.join(' ');
+}

package/dist/utils/date.util.js

@@ -0,0 +1,4 @@
+import { DateTime } from 'luxon';
+export function formatShortDateTime(iso) {
+    return DateTime.fromISO(iso).toLocaleString(DateTime.DATETIME_SHORT);
+}

package/dist/utils/environment-detector.util.js

@@ -0,0 +1,6 @@
+import { isCI } from 'ci-info';
+export const detectExecuteEnvironment = () => {
+    if (isCI || !process.stdout.isTTY)
+        return 'unattended';
+    return 'interactive';
+};

package/dist/utils/file.util.js

@@ -0,0 +1,31 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { homedir } from 'node:os';
+import { DOT_DBDIAGRAM_DIR, CREDENTIALS_FILE_NAME, SETTINGS_FILE_NAME, TELEMETRY_FILE_NAME, } from '../constants/dot-dbdiagram-dir.constant.js';
+export const readAndParseJsonFileSafe = (filePath) => {
+    try {
+        const contents = readFileSync(filePath, 'utf8');
+        return JSON.parse(contents);
+    }
+    catch {
+        return null;
+    }
+};
+export const getProjectDir = () => {
+    return join(process.cwd(), DOT_DBDIAGRAM_DIR);
+};
+export const getGlobalDir = () => {
+    return join(homedir(), DOT_DBDIAGRAM_DIR);
+};
+export const getSettingsFilePath = () => {
+    return join(getProjectDir(), SETTINGS_FILE_NAME);
+};
+export const getProjectCredentialsFilePath = () => {
+    return join(getProjectDir(), CREDENTIALS_FILE_NAME);
+};
+export const getGlobalCredentialsFilePath = () => {
+    return join(getGlobalDir(), CREDENTIALS_FILE_NAME);
+};
+export const getTelemetryFilePath = () => {
+    return join(getGlobalDir(), TELEMETRY_FILE_NAME);
+};

package/dist/utils/output.util.js

@@ -1,18 +1,49 @@
 import Table from 'cli-table3';
+import { log } from '@clack/prompts';
 import { logConsole } from './logger.util.js';
+export const getOutputFormat = (json) => (json ? 'json' : 'plain');
 export function printJson(data) {
     logConsole(JSON.stringify(data, null, 2));
 }
+export const displayError = (error, format) => {
+    if (format === 'json') {
+        printJson({ errorCode: error.errorCode, message: error.message });
+    }
+    else {
+        log.error(error.message);
+    }
+};
+const NO_BORDER_CHAR_CONFIG = {
+    top: '',
+    'top-mid': '',
+    'top-left': '',
+    'top-right': '',
+    bottom: '',
+    'bottom-mid': '',
+    'bottom-left': '',
+    'bottom-right': '',
+    left: '',
+    'left-mid': '',
+    mid: '',
+    'mid-mid': '',
+    right: '',
+    'right-mid': '',
+    middle: '',
+};
 export function printTable(data, config) {
     const table = new Table({
         head: config.head,
-        style: { head: [] },
-        colWidths: config.colWidths,
-        wordWrap: true,
-        wrapOnWordBoundary: false,
+        style: {
+            head: ['gray'],
+            'padding-left': 0,
+            'padding-right': 2,
+        },
+        chars: NO_BORDER_CHAR_CONFIG,
     });
     for (const item of data) {
         table.push(config.rowMapper(item));
+        const spacerRow = new Array(config.head.length).fill('');
+        table.push(spacerRow);
     }
     logConsole(table.toString());
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbdiagram",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "main": "dist/index.js",
   "bin": {
     "dbdiagram": "dist/index.js"
@@ -31,7 +31,9 @@
   "dependencies": {
     "@clack/prompts": "^1.4.0",
     "@dbml/core": "8.2.5",
+    "@snowplow/node-tracker": "^4.9.0",
     "axios": "^1.16.1",
+    "ci-info": "^4.4.0",
     "cli-table3": "^0.6.5",
     "commander": "^15.0.0",
     "dotenv": "^16.4.0",
@@ -50,7 +52,7 @@
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import-x": "^4.16.2",
     "globals": "^17.6.0",
-    "tsx": "^4.21.0",
+    "tsx": "^4.23.0",
     "typescript": "^5.7.0",
     "typescript-eslint": "^8.59.3",
     "vitest": "^4.1.0"

package/dist/constants/auth-message.constant.js

@@ -1 +0,0 @@
-export const NOT_LOGGED_IN_MESSAGE = 'Not logged in. Run `dbdiagram auth login`, or set DBDIAGRAM_TOKEN, to authenticate.';

package/dist/errors/portal-error-codes.js

@@ -1,23 +0,0 @@
-export const DIAGRAM_NOT_FOUND = 'diagram_not_found';
-export const DIAGRAM_PERMISSION_DENIED_VIEW = 'diagram_permission_denied_view';
-export const DIAGRAM_PERMISSION_DENIED_EDIT = 'diagram_permission_denied_edit';
-export const DIAGRAM_PERMISSION_DENIED_DELETE = 'diagram_permission_denied_delete';
-export const DIAGRAM_LIMIT_EXCEEDED = 'diagram_limit_exceeded';
-export const WORKSPACE_NOT_FOUND = 'workspace_not_found';
-export const WORKSPACE_PERMISSION_DENIED_VIEW = 'workspace_permission_denied_view';
-export const TOKEN_NOT_FOUND = 'token_not_found';
-export const TOKEN_LIMIT_EXCEEDED = 'token_limit_exceeded';
-export const VALIDATION_INVALID_PAYLOAD = 'validation_invalid_payload';
-export const INTERNAL_SERVER_ERROR = 'internal_server_error';
-export const PORTAL_ERROR_MESSAGES = {
-    [DIAGRAM_NOT_FOUND]: 'Diagram not found.',
-    [DIAGRAM_PERMISSION_DENIED_VIEW]: 'You do not have access to this diagram.',
-    [DIAGRAM_PERMISSION_DENIED_EDIT]: 'You do not have edit permission on this diagram.',
-    [DIAGRAM_PERMISSION_DENIED_DELETE]: 'You do not have permission to delete this diagram.',
-    [DIAGRAM_LIMIT_EXCEEDED]: 'Diagram limit exceeded for your current plan.',
-    [WORKSPACE_NOT_FOUND]: 'Workspace not found.',
-    [WORKSPACE_PERMISSION_DENIED_VIEW]: 'You do not have access to this workspace.',
-    [TOKEN_NOT_FOUND]: 'Token not found.',
-    [TOKEN_LIMIT_EXCEEDED]: 'Token limit reached. Delete an existing token before creating a new one.',
-    [INTERNAL_SERVER_ERROR]: 'An internal server error occurred. Please try again later.',
-};

package/dist/utils/portal-error.util.js

@@ -1,18 +0,0 @@
-import { PortalApiError } from '../errors/portal-api.error.js';
-import { PORTAL_ERROR_MESSAGES, VALIDATION_INVALID_PAYLOAD } from '../errors/portal-error-codes.js';
-export function isPortalApiError(error) {
-    return error instanceof PortalApiError;
-}
-export function getPortalApiErrorMessage(error) {
-    if (error.errorCode.startsWith('auth_')) {
-        return [
-            'Authentication failed: your credentials are invalid or expired. Try one of:',
-            '  - Replace DBDIAGRAM_TOKEN with a valid token',
-            '  - Unset DBDIAGRAM_TOKEN, then run `dbdiagram auth login` to re-authenticate',
-        ].join('\n');
-    }
-    if (error.errorCode === VALIDATION_INVALID_PAYLOAD) {
-        return error.message;
-    }
-    return PORTAL_ERROR_MESSAGES[error.errorCode] ?? `An unexpected error occurred [${error.errorCode}]`;
-}

package/dist/utils/table.util.js

@@ -1,10 +0,0 @@
-export function computeColWidths(fractions) {
-    const terminalWidth = process.stdout.columns || 100;
-    const numCols = fractions.length;
-    const overhead = numCols * 3 + 1;
-    const available = Math.max(terminalWidth - overhead, numCols * 5);
-    const widths = fractions.map((f) => Math.max(Math.floor(available * f), 5));
-    const used = widths.reduce((a, b) => a + b, 0);
-    widths[widths.length - 1] += available - used;
-    return widths;
-}