dbdiagram 0.5.0 → 0.6.0

package/README.md

@@ -93,18 +93,34 @@ dbdiagram push schema.dbml --new                       # force-create, ignoring
 
 ### Pull
 
-Pull DBML content from a diagram on dbdiagram.io.
+Pull DBML content from a diagram on dbdiagram.io or a document on dbdocs.io.
 
 **Options:**
 
 - `--diagram-id <id>` — The diagram to pull from
+- `--project <name>` — The document to pull from, as `<workspace>/<project>` or just `<project>`
 - `-o, --out-file <filepath>` — Save to a file (omit to use the configured entry file from settings, or print to stdout)
 
+**Source resolution:**
+
+| Input | Resolves to |
+| --- | --- |
+| `--diagram-id <id>` | The given diagram |
+| `--project <workspace>/<project>` | The given document |
+| `--project <project>`, no `/` | The document `<project>` in the workspace from settings |
+| Neither flag | The diagram from settings (`diagram.id`) |
+| Both flags | The one appearing last on the command line wins |
+
 ```sh
 dbdiagram pull --diagram-id <id>                       # print to stdout (or save to the configured entry file)
 dbdiagram pull --diagram-id <id> -o schema.dbml        # save to a specific file
+dbdiagram pull --project myteam/myproject              # pull a document, print to stdout
+dbdiagram pull --project myproject -o schema.dbml      # pull a document, workspace from settings
 ```
 
+A document or diagram with no DBML yet returns empty content: pull warns and skips the write rather than
+overwriting your local file (and its viz file) with nothing, and exits `0`.
+
 ---
 
 ### List

package/dist/actions/build/build-document.action.js

@@ -2,18 +2,19 @@ import { readFile } from 'node:fs/promises';
 import { log, spinner } from '@clack/prompts';
 import { DBDOCS_CONFIGS } from '../../config.js';
 import { getCredential } from '../../config/credential-manager.js';
-import { DOCUMENT_SOURCE_TYPE } from '../../constants/document.constant.js';
-import { AUTH_NOT_LOGGED_IN, FILE_READ_ERROR, PROJECT_NAME_INVALID, PROJECT_NAME_MISSING, SOURCE_MISSING, VERSION_NAME_INVALID, WORKSPACE_NAME_INVALID, WORKSPACE_NAME_MISSING, } from '../../constants/cli-error.constant.js';
+import { DOCUMENT_SOURCE_CLIENT_TYPE, DOCUMENT_SOURCE_TYPE } from '../../constants/document.constant.js';
+import { AUTH_NOT_LOGGED_IN, SOURCE_MISSING, VERSION_NAME_INVALID, FILE_READ_ERROR, } from '../../constants/cli-error.constant.js';
 import { CliError } from '../../errors/cli.error.js';
 import { portalIntegration } from '../../integrations/portal/portal.integration.js';
 import { trackEvent } from '../../services/telemetry.service.js';
 import { prepareBuildDocumentData } from '../../services/dbml/dbml.service.js';
+import { deriveDiagramVizPathFromDBML, readDiagramVizFile } from '../../services/viz/diagram-viz-file.service.js';
+import { toDiagramVizData, toDocumentVizData } from '../../services/viz/diagram-viz-converter.service.js';
 import { getCliErrorMessageFromCode, toCliError } from '../../utils/cli-error.util.js';
 import { getDbmlVersion } from '../../utils/dbml.util.js';
 import { DbmlParseError } from '../../errors/dbml-parse.error.js';
 import { displayDbmlParseError, displayError, getOutputFormat, printJson } from '../../utils/output.util.js';
-import { validateProjectUrlName, validateVersionName, validateWorkspaceUrlName, } from '../../utils/validation.util.js';
-const DOCUMENT_SOURCE_CLIENT_TYPE = 'dbdiagram-cli';
+import { validateAndResolveBuildDocumentProjectNames, validateVersionName } from '../../utils/validation.util.js';
 export async function documentAction(options) {
     const credential = getCredential();
     if (!credential) {
@@ -27,33 +28,18 @@ export async function documentAction(options) {
             return displayError(new CliError(VERSION_NAME_INVALID, versionError), getOutputFormat(options.json));
         }
     }
-    if (!options.workspaceUrlName) {
+    const resolvedNames = validateAndResolveBuildDocumentProjectNames(options.workspaceUrlName, options.projectUrlOrName);
+    if (resolvedNames instanceof CliError) {
         process.exitCode = 1;
-        return displayError(new CliError(WORKSPACE_NAME_MISSING, getCliErrorMessageFromCode(WORKSPACE_NAME_MISSING)), getOutputFormat(options.json));
-    }
-    const workspaceError = validateWorkspaceUrlName(options.workspaceUrlName);
-    if (workspaceError) {
-        process.exitCode = 1;
-        return displayError(new CliError(WORKSPACE_NAME_INVALID, workspaceError), getOutputFormat(options.json));
-    }
-    if (!options.projectUrlOrName) {
-        process.exitCode = 1;
-        return displayError(new CliError(PROJECT_NAME_MISSING, getCliErrorMessageFromCode(PROJECT_NAME_MISSING)), getOutputFormat(options.json));
-    }
-    if (options.projectUrlOrName.includes('/')) {
-        process.exitCode = 1;
-        return displayError(new CliError(PROJECT_NAME_INVALID, 'Invalid --project value. Expected <workspace>/<project> or <project>.'), getOutputFormat(options.json));
-    }
-    const projectError = validateProjectUrlName(options.projectUrlOrName);
-    if (projectError) {
-        process.exitCode = 1;
-        return displayError(new CliError(PROJECT_NAME_INVALID, projectError), getOutputFormat(options.json));
+        return displayError(resolvedNames, getOutputFormat(options.json));
     }
+    const { workspaceUrlName: targetWorkspaceUrlName, projectUrlOrName: targetProjectUrlOrName, } = resolvedNames;
     if (options.source === undefined) {
         process.exitCode = 1;
         return displayError(new CliError(SOURCE_MISSING, getCliErrorMessageFromCode(SOURCE_MISSING)), getOutputFormat(options.json));
     }
     let content;
+    let vizData;
     if (options.source.type === DOCUMENT_SOURCE_TYPE.FILE) {
         try {
             content = await readFile(options.source.value, 'utf8');
@@ -63,11 +49,17 @@ export async function documentAction(options) {
             process.exitCode = 1;
             return displayError(new CliError(FILE_READ_ERROR, `Failed to read file: ${message}`), getOutputFormat(options.json));
         }
+        const vizPath = deriveDiagramVizPathFromDBML(options.source.value);
+        const vizResult = await readDiagramVizFile(vizPath);
+        if (vizResult.ok) {
+            vizData = toDocumentVizData(toDiagramVizData(vizResult.state));
+        }
     }
     else {
         try {
             const diagram = await portalIntegration.getDiagram(options.source.value);
             content = diagram.content;
+            vizData = diagram.vizData ? toDocumentVizData(diagram.vizData) : undefined;
         }
         catch (error) {
             process.exitCode = 1;
@@ -98,9 +90,9 @@ export async function documentAction(options) {
     try {
         const currentUser = await portalIntegration.getCurrentUser();
         const { project } = await portalIntegration.createDocument({
-            projectName: options.projectUrlOrName,
+            projectName: targetProjectUrlOrName,
             projectDescription: preparedDocumentData.description,
-            workspaceUrlName: options.workspaceUrlName,
+            workspaceUrlName: targetWorkspaceUrlName,
             clientType: DOCUMENT_SOURCE_CLIENT_TYPE,
             doc: {
                 content,
@@ -109,6 +101,7 @@ export async function documentAction(options) {
             shallowSchema: preparedDocumentData.shallowSchema,
             normalizedDatabase: preparedDocumentData.normalizedDatabase,
             dbmlVersion: getDbmlVersion(),
+            vizData,
         });
         const { workspaceUrl: workspaceUrlName, urlName: projectUrlName } = project;
         trackEvent({

package/dist/actions/pull.action.js

@@ -1,4 +1,4 @@
-import { spinner } from '@clack/prompts';
+import { log, spinner } from '@clack/prompts';
 import { getCredential } from '../config/credential-manager.js';
 import { writeFileWithDir } from '../services/file.service.js';
 import { portalIntegration } from '../integrations/portal/portal.integration.js';
@@ -7,7 +7,9 @@ import { fromServerFormat } from '../services/viz/diagram-viz-converter.service.
 import { logConsole } from '../utils/logger.util.js';
 import { CliError } from '../errors/cli.error.js';
 import { AUTH_NOT_LOGGED_IN, DIAGRAM_ID_MISSING } from '../constants/cli-error.constant.js';
+import { PULL_SOURCE_TYPE } from '../constants/pull.constant.js';
 import { getCliErrorMessageFromCode, toCliError } from '../utils/cli-error.util.js';
+import { validateAndResolvePullDocumentProjectNames } from '../utils/validation.util.js';
 import { displayError } from '../utils/output.util.js';
 export async function pullAction(options) {
     const credential = getCredential();
@@ -16,33 +18,68 @@ export async function pullAction(options) {
         process.exitCode = 1;
         return;
     }
-    if (!options.diagramId) {
+    const { source } = options;
+    if (!source) {
         displayError(new CliError(DIAGRAM_ID_MISSING, getCliErrorMessageFromCode(DIAGRAM_ID_MISSING)), 'plain');
         process.exitCode = 1;
         return;
     }
+    let target;
+    if (source.type === PULL_SOURCE_TYPE.DOCUMENT) {
+        const resolved = validateAndResolvePullDocumentProjectNames(source.workspaceUrlName, source.projectUrlOrName);
+        if (resolved instanceof CliError) {
+            displayError(resolved, 'plain');
+            process.exitCode = 1;
+            return;
+        }
+        target = { kind: 'document', ...resolved };
+    }
+    else {
+        target = { kind: 'diagram', diagramId: source.value };
+    }
+    const isDocumentSource = target.kind === 'document';
     const s = spinner();
-    s.start('Fetching diagram...');
+    s.start(isDocumentSource ? 'Fetching document...' : 'Fetching diagram...');
     try {
-        const diagram = await portalIntegration.getDiagram(options.diagramId);
+        let content;
+        let vizData;
+        let successLabel;
+        if (target.kind === 'document') {
+            const { workspaceUrlName, projectUrlOrName } = target;
+            const document = await portalIntegration.getDocument(workspaceUrlName, projectUrlOrName);
+            content = document.content;
+            vizData = document.vizData;
+            successLabel = `${workspaceUrlName}/${projectUrlOrName}`;
+        }
+        else {
+            const diagram = await portalIntegration.getDiagram(target.diagramId);
+            content = diagram.content;
+            vizData = diagram.vizData;
+            successLabel = diagram.name ? `"${diagram.name}"` : 'your diagram';
+        }
         if (options.outFile) {
-            await writeFileWithDir(options.outFile, diagram.content);
-            if (diagram.vizData) {
+            if (!content || !content.trim()) {
+                s.stop();
+                log.warn('Pulled content is empty. Skipping write to avoid overwriting local files.');
+                process.exitCode = 0;
+                return;
+            }
+            await writeFileWithDir(options.outFile, content);
+            if (vizData) {
                 const vizPath = deriveDiagramVizPathFromDBML(options.outFile);
                 const existingResult = await readDiagramVizFile(vizPath);
-                const state = fromServerFormat(diagram.vizData, existingResult.ok ? existingResult.state : undefined);
+                const state = fromServerFormat(vizData, existingResult.ok ? existingResult.state : undefined);
                 await writeDiagramVizFile(vizPath, state);
             }
-            const label = diagram.name ? `"${diagram.name}"` : 'your diagram';
-            s.stop(`Saved ${label} to ${options.outFile}`);
+            s.stop(`Saved ${successLabel} to ${options.outFile}`);
         }
         else {
-            s.stop('Diagram fetched successfully.');
-            logConsole(diagram.content);
+            s.stop(isDocumentSource ? 'Document fetched successfully.' : 'Diagram fetched successfully.');
+            logConsole(content);
         }
     }
     catch (error) {
-        s.stop('Failed to fetch diagram.');
+        s.stop(isDocumentSource ? 'Failed to fetch document.' : 'Failed to fetch diagram.');
         displayError(toCliError(error), 'plain');
         process.exitCode = 1;
     }

package/dist/actions/push.action.js

@@ -4,7 +4,7 @@ import { getCredential } from '../config/credential-manager.js';
 import { portalIntegration } from '../integrations/portal/portal.integration.js';
 import { trackEvent } from '../services/telemetry.service.js';
 import { deriveDiagramVizPathFromDBML, readDiagramVizFile } from '../services/viz/diagram-viz-file.service.js';
-import { toServerFormat } from '../services/viz/diagram-viz-converter.service.js';
+import { toDiagramVizData } from '../services/viz/diagram-viz-converter.service.js';
 import { preparePushDiagramData } from '../services/dbml/dbml.service.js';
 import { DBDIAGRAM_CONFIGS } from '../config.js';
 import { CliError } from '../errors/cli.error.js';
@@ -48,7 +48,7 @@ export async function pushAction(filepath, options, thisCommand) {
     let vizData;
     if (vizResult.ok) {
         const { diagramViews } = preparedPushData;
-        vizData = toServerFormat(vizResult.state, diagramViews);
+        vizData = toDiagramVizData(vizResult.state, diagramViews);
     }
     const s = spinner();
     s.start('Pushing diagram to dbdiagram...');

package/dist/commands/pull.command.js

@@ -1,11 +1,19 @@
 import { pullAction } from '../actions/pull.action.js';
 import { pullPreAction } from '../hooks/pull.hook.js';
+import { PULL_SOURCE_TYPE } from '../constants/pull.constant.js';
 export function registerPullCommand(program) {
-    program
+    const cmd = program
         .command('pull')
-        .description('Pull the DBML content of a diagram to your local machine')
+        .description('Pull the DBML content of a diagram or dbdocs document to your local machine')
         .option('--diagram-id <id>', 'The diagram ID to pull from')
+        .option('--project <name>', 'The dbdocs document to pull from, as <workspace>/<project> or just <project>')
         .option('--out-file, -o <filepath>', 'Save to a file (omit to use the configured entry file, or stdout)')
         .hook('preAction', pullPreAction)
         .action(pullAction);
+    cmd.on('option:diagram-id', (val) => {
+        cmd.setOptionValue('sourceFlag', { type: PULL_SOURCE_TYPE.DIAGRAM, value: val });
+    });
+    cmd.on('option:project', (val) => {
+        cmd.setOptionValue('sourceFlag', { type: PULL_SOURCE_TYPE.DOCUMENT, value: val });
+    });
 }

package/dist/constants/cli-error.constant.js

@@ -16,9 +16,16 @@ export const WORKSPACE_NAME_MISSING = 'workspace_name_missing';
 export const WORKSPACE_NAME_INVALID = 'workspace_name_invalid';
 export const WORKSPACE_NOT_FOUND = 'workspace_not_found';
 export const WORKSPACE_PERMISSION_DENIED = 'workspace_permission_denied';
+export const WORKSPACE_PERMISSION_DENIED_CREATE_PROJECT = 'workspace_permission_denied_create_project';
+export const WORKSPACE_PERMISSION_DENIED_LIST_PROJECT = 'workspace_permission_denied_list_project';
 export const PROJECT_NAME_MISSING = 'project_name_missing';
 export const PROJECT_NAME_INVALID = 'project_name_invalid';
 export const VERSION_NAME_INVALID = 'version_name_invalid';
+export const PROJECT_NOT_FOUND = 'project_not_found';
+export const PROJECT_PERMISSION_DENIED = 'project_permission_denied';
+export const PROJECT_PASSWORD_REQUIRED = 'project_password_required';
+export const PROJECT_PERMISSION_DENIED_EDIT = 'project_permission_denied_edit';
+export const LINK_USER_FAILED = 'link_user_failed';
 export const TOKEN_NOT_FOUND = 'token_not_found';
 export const TOKEN_LIMIT_EXCEEDED = 'token_limit_exceeded';
 export const FILE_PATH_MISSING = 'file_path_missing';
@@ -56,14 +63,22 @@ export const CLI_ERROR_MESSAGES = {
         + 'or set workspaceUrlName in settings.json',
     [WORKSPACE_NOT_FOUND]: 'Workspace not found.',
     [WORKSPACE_PERMISSION_DENIED]: 'You do not have permission to access this workspace.',
+    [WORKSPACE_PERMISSION_DENIED_CREATE_PROJECT]: 'You do not have permission to create a project in this workspace.',
+    [WORKSPACE_PERMISSION_DENIED_LIST_PROJECT]: 'You do not have permission to list projects in this workspace.',
     [PROJECT_NAME_MISSING]: 'Project name/url name is required. Use --project <workspace>/<project> '
         + 'or set projectUrlName in settings.json',
+    [PROJECT_NOT_FOUND]: 'Document not found.',
+    [PROJECT_PERMISSION_DENIED]: 'You do not have permission to access this document.',
+    [PROJECT_PASSWORD_REQUIRED]: 'This document is password-protected and cannot be accessed via the CLI.',
+    [PROJECT_PERMISSION_DENIED_EDIT]: 'You do not have edit permission on this document.',
     [TOKEN_NOT_FOUND]: 'Token not found.',
     [TOKEN_LIMIT_EXCEEDED]: 'Token limit reached. Delete an existing token before creating a new one.',
     [FILE_PATH_MISSING]: 'Missing required argument: filepath. Provide it as an argument or set dbml.entry in settings.json.',
     [SOURCE_MISSING]: 'One source must be specified: --from-file or --from-diagram',
     [CONFIRMATION_REQUIRED]: 'Confirmation required. Pass --force (-f) to delete in a non-interactive environment.',
     [INTERNAL_SERVER_ERROR]: 'An internal server error occurred. Please try again later.',
+    [LINK_USER_FAILED]: 'Failed to link your account with dbdocs. This is a portal-side issue, not an authentication '
+        + 'problem; please try again or contact support.',
     [NETWORK_ERROR]: 'Network error: could not reach the server. Check your connection and try again.',
 };
 export const PORTAL_TO_CLI_CODE = {
@@ -74,6 +89,13 @@ export const PORTAL_TO_CLI_CODE = {
     diagram_limit_exceeded: DIAGRAM_LIMIT_EXCEEDED,
     workspace_not_found: WORKSPACE_NOT_FOUND,
     workspace_permission_denied_view: WORKSPACE_PERMISSION_DENIED,
+    project_not_found: PROJECT_NOT_FOUND,
+    project_permission_denied_view: PROJECT_PERMISSION_DENIED,
+    project_permission_denied_view_password_required: PROJECT_PASSWORD_REQUIRED,
+    project_permission_denied_edit: PROJECT_PERMISSION_DENIED_EDIT,
+    workspace_permission_denied_create_project: WORKSPACE_PERMISSION_DENIED_CREATE_PROJECT,
+    workspace_permission_denied_list_project: WORKSPACE_PERMISSION_DENIED_LIST_PROJECT,
+    link_user_failed: LINK_USER_FAILED,
     token_not_found: TOKEN_NOT_FOUND,
     token_limit_exceeded: TOKEN_LIMIT_EXCEEDED,
     internal_server_error: INTERNAL_SERVER_ERROR,

package/dist/constants/document.constant.js

@@ -6,3 +6,4 @@ export const PROJECT_URL_NAME_PATTERN = /^[A-Za-z0-9_\-@.\s]+$/;
 export const WORKSPACE_URL_NAME_PATTERN = /^[A-Za-z0-9_\-@.\s]+$/;
 export const URL_NAME_MAX_LENGTH = 255;
 export const VERSION_NAME_MAX_LENGTH = 255;
+export const DOCUMENT_SOURCE_CLIENT_TYPE = 'dbdiagram-cli';

package/dist/constants/pull.constant.js

@@ -0,0 +1,4 @@
+export const PULL_SOURCE_TYPE = {
+    DIAGRAM: 'diagram',
+    DOCUMENT: 'document',
+};

package/dist/hooks/build-document.hook.js

@@ -1,20 +1,20 @@
 import { getSettings } from '../config/settings-manager.js';
 import { DOCUMENT_SOURCE_TYPE } from '../constants/document.constant.js';
+import { parseProjectFlag } from '../utils/document.util.js';
+export function normalizeBuildDocumentFlags(cmd) {
+    const projectFlag = cmd.getOptionValue('project');
+    if (projectFlag === undefined || projectFlag === null)
+        return;
+    const { workspaceUrlName, projectUrlOrName } = parseProjectFlag(projectFlag);
+    if (workspaceUrlName !== undefined) {
+        cmd.setOptionValue('workspaceUrlName', workspaceUrlName);
+    }
+    cmd.setOptionValue('projectUrlOrName', projectUrlOrName);
+}
 export function resolveBuildDocumentFlags(cmd, settings) {
     if (cmd.getOptionValue('source') == null && settings.dbml?.entry) {
         cmd.setOptionValue('source', { type: DOCUMENT_SOURCE_TYPE.FILE, value: settings.dbml.entry });
     }
-    const projectFlag = cmd.getOptionValue('project');
-    if (projectFlag != null) {
-        const slashIndex = projectFlag.indexOf('/');
-        if (slashIndex >= 0) {
-            cmd.setOptionValue('workspaceUrlName', projectFlag.slice(0, slashIndex));
-            cmd.setOptionValue('projectUrlOrName', projectFlag.slice(slashIndex + 1));
-        }
-        else {
-            cmd.setOptionValue('projectUrlOrName', projectFlag);
-        }
-    }
     if (cmd.getOptionValue('workspaceUrlName') == null && settings.document?.workspaceUrlName) {
         cmd.setOptionValue('workspaceUrlName', settings.document.workspaceUrlName);
     }
@@ -23,6 +23,7 @@ export function resolveBuildDocumentFlags(cmd, settings) {
     }
 }
 export function buildDocumentPreAction(thisCommand) {
+    normalizeBuildDocumentFlags(thisCommand);
     const settings = getSettings();
     if (!settings)
         return;

package/dist/hooks/pull.hook.js

@@ -1,13 +1,33 @@
 import { getSettings } from '../config/settings-manager.js';
+import { PULL_SOURCE_TYPE } from '../constants/pull.constant.js';
+import { parseProjectFlag } from '../utils/document.util.js';
+export function normalizePullFlags(cmd) {
+    const sourceFlag = cmd.getOptionValue('sourceFlag');
+    if (sourceFlag === undefined || sourceFlag === null)
+        return;
+    const source = sourceFlag.type === PULL_SOURCE_TYPE.DOCUMENT
+        ? { type: PULL_SOURCE_TYPE.DOCUMENT, ...parseProjectFlag(sourceFlag.value) }
+        : { type: PULL_SOURCE_TYPE.DIAGRAM, value: sourceFlag.value };
+    cmd.setOptionValue('source', source);
+}
 export function resolvePullFlags(cmd, settings) {
-    if (cmd.getOptionValue('diagramId') == null && settings.diagram?.id) {
-        cmd.setOptionValue('diagramId', settings.diagram.id);
+    const source = cmd.getOptionValue('source');
+    if (source == null) {
+        if (settings.diagram?.id) {
+            cmd.setOptionValue('source', { type: PULL_SOURCE_TYPE.DIAGRAM, value: settings.diagram.id });
+        }
+    }
+    else if (source.type === PULL_SOURCE_TYPE.DOCUMENT) {
+        if (source.workspaceUrlName == null && settings.document?.workspaceUrlName) {
+            cmd.setOptionValue('source', { ...source, workspaceUrlName: settings.document.workspaceUrlName });
+        }
     }
     if (cmd.getOptionValue('outFile') == null && settings.dbml?.entry) {
         cmd.setOptionValue('outFile', settings.dbml.entry);
     }
 }
 export function pullPreAction(thisCommand) {
+    normalizePullFlags(thisCommand);
     const settings = getSettings();
     if (!settings)
         return;

package/dist/integrations/portal/portal.integration.js

@@ -14,6 +14,10 @@ async function createDocument(req) {
     const { data } = await portalHttpClient.post(`${CLI_BASE_PATH}/projects`, req);
     return data;
 }
+async function getDocument(workspaceUrlName, projectUrlName) {
+    const { data } = await portalHttpClient.get(`${CLI_BASE_PATH}/workspaces/${workspaceUrlName}/projects/${projectUrlName}`);
+    return data;
+}
 async function updateDiagram(req) {
     const { name, dbml, vizData } = req;
     const { data } = await portalHttpClient.put(`${CLI_BASE_PATH}/diagrams/${req.diagramId}`, { name, dbml, vizData });
@@ -58,6 +62,7 @@ export const portalIntegration = {
     updateDiagram,
     createDocument,
     getDiagram,
+    getDocument,
     deleteDiagram,
     listDiagrams,
     listWorkspaces,

package/dist/services/viz/diagram-viz-converter.service.js

@@ -48,7 +48,7 @@ const toDetailLevel = (value) => (Object.values(DetailLevel).includes(value)
 const toRelationshipMode = (value) => (Object.values(RelationshipMode).includes(value)
     ? value
     : DEFAULT_RELATIONSHIP_MODE);
-export const toServerFormat = (state, diagramViews) => {
+export const toDiagramVizData = (state, diagramViews) => {
     const { defaultView, views } = state;
     const viewEntitiesMap = new Map(diagramViews?.map((v) => [v.name, v.visibleEntities]));
     return {
@@ -71,6 +71,23 @@ export const toServerFormat = (state, diagramViews) => {
         })),
     };
 };
+export const toDocumentVizData = (vizData) => {
+    return {
+        diagram: vizData.diagram,
+        referencePaths: vizData.referencePaths,
+        stickyNoteLayouts: vizData.stickyNoteLayouts,
+        tableGroups: vizData.tableGroups,
+        detailLevel: vizData.detailLevel,
+        views: vizData.views.map((view) => ({
+            name: view.name,
+            detailLevel: view.detailLevel,
+            tablePositions: view.tablePositions,
+            tableGroupCollapsedStates: view.tableGroupCollapsedStates,
+            stickyNoteLayouts: view.stickyNoteLayouts,
+            referencePaths: view.referencePaths,
+        })),
+    };
+};
 const viewFromServer = (view) => {
     return {
         detailLevel: toDetailLevel(view.detailLevel),

package/dist/types/document.type.js

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

package/dist/types/pull.type.js

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

package/dist/utils/document.util.js

@@ -0,0 +1,7 @@
+export const parseProjectFlag = (value) => {
+    const slashIndex = value.indexOf('/');
+    if (slashIndex >= 0) {
+        return { workspaceUrlName: value.slice(0, slashIndex), projectUrlOrName: value.slice(slashIndex + 1) };
+    }
+    return { projectUrlOrName: value };
+};

package/dist/utils/validation.util.js

@@ -1,4 +1,7 @@
+import { PROJECT_NAME_INVALID, PROJECT_NAME_MISSING, WORKSPACE_NAME_INVALID, WORKSPACE_NAME_MISSING, } from '../constants/cli-error.constant.js';
 import { PROJECT_URL_NAME_PATTERN, URL_NAME_MAX_LENGTH, VERSION_NAME_MAX_LENGTH, WORKSPACE_URL_NAME_PATTERN, } from '../constants/document.constant.js';
+import { CliError } from '../errors/cli.error.js';
+import { getCliErrorMessageFromCode } from './cli-error.util.js';
 const INVALID_URL_NAME_MESSAGE = 'Invalid name. Must contain only letters, numbers, spaces, and _ - @ . characters.';
 export function validateProjectUrlName(value) {
     if (value.trim() === '') {
@@ -30,3 +33,41 @@ export function validateVersionName(value) {
     }
     return null;
 }
+function toWorkspaceNameFormatError(workspaceUrlName) {
+    const workspaceError = validateWorkspaceUrlName(workspaceUrlName);
+    return workspaceError ? new CliError(WORKSPACE_NAME_INVALID, workspaceError) : null;
+}
+function toProjectNameError(projectUrlOrName) {
+    if (projectUrlOrName.includes('/')) {
+        return new CliError(PROJECT_NAME_INVALID, 'Invalid --project value. Expected <workspace>/<project> or <project>.');
+    }
+    const projectError = validateProjectUrlName(projectUrlOrName);
+    return projectError ? new CliError(PROJECT_NAME_INVALID, projectError) : null;
+}
+export function validateAndResolveBuildDocumentProjectNames(workspaceUrlName, projectUrlOrName) {
+    if (!workspaceUrlName) {
+        return new CliError(WORKSPACE_NAME_MISSING, getCliErrorMessageFromCode(WORKSPACE_NAME_MISSING));
+    }
+    const workspaceFormatError = toWorkspaceNameFormatError(workspaceUrlName);
+    if (workspaceFormatError)
+        return workspaceFormatError;
+    if (!projectUrlOrName) {
+        return new CliError(PROJECT_NAME_MISSING, getCliErrorMessageFromCode(PROJECT_NAME_MISSING));
+    }
+    const projectError = toProjectNameError(projectUrlOrName);
+    if (projectError)
+        return projectError;
+    return { workspaceUrlName, projectUrlOrName };
+}
+export function validateAndResolvePullDocumentProjectNames(workspaceUrlName, projectUrlOrName) {
+    if (!workspaceUrlName) {
+        return new CliError(WORKSPACE_NAME_MISSING, getCliErrorMessageFromCode(WORKSPACE_NAME_MISSING));
+    }
+    const workspaceFormatError = toWorkspaceNameFormatError(workspaceUrlName);
+    if (workspaceFormatError)
+        return workspaceFormatError;
+    const projectError = toProjectNameError(projectUrlOrName);
+    if (projectError)
+        return projectError;
+    return { workspaceUrlName, projectUrlOrName };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbdiagram",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "main": "dist/index.js",
   "bin": {
     "dbdiagram": "dist/index.js"