@chengxianglibra/dsh-data-analysis 0.1.2 → 0.2.1

package/lib/client/credentials/create-datasource.js

@@ -1,67 +1,171 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 // @ts-nocheck -- JSX is bundled by the plugin client build.
-import { useEffect, useState } from 'react';
-export function CreateDatasource({ model, workspaceId, close }) {
+import { useEffect, useId, useRef, useState } from 'react';
+import { useCopy } from "./../i18n/context.js";
+import { errorMessage, message } from "./../i18n/copy.js";
+import { credentialReference, prepareCredentials } from "./credential-draft.js";
+import { creationFieldValues } from "./defaults.js";
+import { datasourceDescription } from "./descriptions.js";
+function credentialLabel(field) {
+    return ({
+        user_env: 'marivo.credentials.username',
+        password_env: 'marivo.credentials.password',
+        http_bearer_token_env: 'marivo.credentials.access-token',
+        http_headers_env: 'marivo.credentials.header-credential-value',
+    }[field] ?? field.replace(/_env$/, ''));
+}
+function credentialRows(schema, backend, values = {}) {
+    return (schema.backends.find((item) => item.name === backend)?.fields ?? [])
+        .filter((field) => field.name.endsWith('_env'))
+        .flatMap((field) => field.type === 'json'
+        ? Object.entries(values[field.name] ?? {}).map(([key, existing]) => ({
+            id: crypto.randomUUID(),
+            field: field.name,
+            key,
+            existing,
+            value: '',
+        }))
+        : [{ id: crypto.randomUUID(), field: field.name, existing: values[field.name], value: '' }]);
+}
+export function CreateDatasource({ model, workspaceId, close, name, requestId }) {
+    const t = useCopy();
+    const formId = useId();
+    const active = useRef(false);
     const [schema, setSchema] = useState(null);
+    const [original, setOriginal] = useState(null);
     const [backend, setBackend] = useState('');
     const [values, setValues] = useState({});
+    const [credentials, setCredentials] = useState([]);
     const [busy, setBusy] = useState(false);
     const [error, setError] = useState('');
     useEffect(() => {
         const controller = new AbortController();
-        model
-            .authoring(workspaceId, controller.signal)
-            .then((value) => {
+        active.current = true;
+        Promise.all([
+            model.authoring(workspaceId, controller.signal, name ? 'edit' : 'create'),
+            name ? model.configuration(workspaceId, name, controller.signal) : Promise.resolve(null),
+        ])
+            .then(([value, configuration]) => {
             if (controller.signal.aborted)
                 return;
             setSchema(value);
-            setBackend(value.backends[0]?.name ?? '');
+            setOriginal(configuration);
+            setBackend(configuration?.backend ?? value.backends[0]?.name ?? '');
+            setCredentials(credentialRows(value, configuration?.backend ?? value.backends[0]?.name, configuration?.fields));
+            if (!configuration)
+                setValues(creationFieldValues(value, value.backends[0]?.name ?? ''));
+            if (configuration) {
+                const fields = value.backends.find((item) => item.name === configuration.backend)?.fields;
+                if (!fields)
+                    throw new Error('marivo.credentials.this-runtime-cannot-fully-edit-this-datasource');
+                setValues(Object.fromEntries(fields
+                    .filter((field) => !field.name.endsWith('_env') && configuration.fields[field.name] !== undefined)
+                    .map((field) => [
+                    field.name,
+                    field.type === 'string'
+                        ? configuration.fields[field.name]
+                        : JSON.stringify(configuration.fields[field.name]),
+                ])));
+            }
         })
             .catch((error) => {
             if (!controller.signal.aborted)
-                setError(error.message);
+                setError(errorMessage(error));
         });
-        return () => controller.abort();
-    }, [model, workspaceId]);
+        return () => {
+            active.current = false;
+            controller.abort();
+        };
+    }, [model, workspaceId, name]);
     const fields = schema?.backends.find((item) => item.name === backend)?.fields ?? [];
+    const credentialFields = fields.filter((field) => field.name.endsWith('_env'));
+    const updateCredential = (id, change) => setCredentials((rows) => rows.map((row) => (row.id === id ? { ...row, ...change } : row)));
     async function submit(event) {
         event.preventDefault();
         if (busy)
             return;
         setError('');
         const input = {};
+        let changes = {};
         try {
-            for (const field of fields) {
+            for (const field of fields.filter((field) => !field.name.endsWith('_env'))) {
                 const value = values[field.name];
-                if (value === undefined || value === '')
+                if (value === undefined)
+                    continue;
+                if (value === '' &&
+                    (field.type !== 'string' ||
+                        (name
+                            ? original?.fields[field.name] !== ''
+                            : schema.creationDefaults?.[backend]?.[field.name] !== '')))
                     continue;
                 input[field.name] = field.type === 'string' ? value : JSON.parse(value);
             }
+            const prepared = prepareCredentials(input.name ?? '', credentials);
+            Object.assign(input, prepared.fields);
+            changes = prepared.changes;
         }
-        catch {
-            setError('请检查数字、布尔值或 JSON 字段的格式。');
+        catch (error) {
+            setError(error instanceof SyntaxError
+                ? 'marivo.credentials.check-the-format-of-number-boolean-and-json-fields'
+                : errorMessage(error));
             return;
         }
         setBusy(true);
+        // Remove secrets from mounted inputs as soon as the explicit submission begins.
+        setCredentials((rows) => rows.map((row) => ({ ...row, value: '' })));
         try {
-            await model.createDatasource(workspaceId, schema, { backend, fields: input });
-            close();
+            await model.saveConfiguration(workspaceId, schema, { backend, fields: input }, original, requestId, changes);
+            if (active.current)
+                close();
         }
         catch (error) {
-            setError(error.message);
+            if (active.current)
+                setError(message('marivo.credentials.value-credential-inputs-have-been-cleared-enter-them-again', {
+                    p0: errorMessage(error),
+                }));
         }
         finally {
-            setBusy(false);
+            for (const ref of Object.keys(changes))
+                delete changes[ref];
+            if (active.current)
+                setBusy(false);
         }
     }
-    return (_jsxs("form", { className: "mc-form", "aria-label": "\u65B0\u589E\u6570\u636E\u6E90", onSubmit: submit, children: [_jsxs("div", { className: "mc-form-body", children: [_jsx("div", { className: "mc-detail-heading", children: _jsx("h3", { children: "\u65B0\u589E\u6570\u636E\u6E90" }) }), error && (_jsx("p", { role: "alert", className: "mc-result", "data-tone": "error", children: error })), !schema && !error && _jsx("p", { role: "status", children: "\u6B63\u5728\u8BFB\u53D6\u6570\u636E\u6E90\u914D\u7F6E\u5B57\u6BB5\u2026" }), schema && (_jsxs("fieldset", { className: "mc-field", disabled: busy, children: [_jsxs("label", { className: "mc-secret-input", children: ["\u5F15\u64CE", _jsx("select", { "aria-label": "\u5F15\u64CE", value: backend, onChange: (event) => {
+    return (_jsxs("form", { className: "mc-form", "aria-label": name ? t('marivo.credentials.edit-datasource') : t('marivo.credentials.add-datasource'), onSubmit: submit, children: [_jsxs("div", { className: "mc-form-body", children: [_jsx("div", { className: "mc-detail-heading", children: _jsx("h3", { children: name
+                                ? t('marivo.credentials.edit-datasource')
+                                : t('marivo.credentials.add-datasource') }) }), error && (_jsx("p", { role: "alert", className: "mc-result", "data-tone": "error", children: t(error) })), !schema && !error && (_jsx("p", { role: "status", children: t('marivo.credentials.loading-datasource-configuration-fields') })), schema && (_jsxs("fieldset", { className: "mc-field", disabled: busy, children: [_jsxs("label", { className: "mc-secret-input", children: [t('marivo.credentials.engine'), _jsx("select", { "aria-label": t('marivo.credentials.engine'), disabled: !!name, value: backend, onChange: (event) => {
                                             setBackend(event.target.value);
-                                            setValues({});
+                                            setValues(creationFieldValues(schema, event.target.value));
+                                            setCredentials(credentialRows(schema, event.target.value));
                                             setError('');
-                                        }, children: schema.backends.map((item) => (_jsx("option", { value: item.name, children: item.name }, item.name))) })] }), fields.map((field) => (_jsxs("label", { className: "mc-secret-input", htmlFor: `mc-create-${field.name}`, children: [_jsxs("span", { className: "mc-input-heading", children: [_jsxs("span", { className: "mc-input-name", children: [field.name, field.name.endsWith('_env') ? '（凭证引用名）' : '', field.required ? ' *' : ''] }), (field.description || field.name.endsWith('_env')) && (_jsxs("span", { className: "mc-input-description", children: [field.description, field.name.endsWith('_env') &&
-                                                        ' 填写引用名，如 MY_DB_PASSWORD；仅使用字母、数字和下划线，不能以数字开头。实际用户名或密码请在创建后的“新增凭证”中填写。'] }))] }), field.type === 'boolean' ? (_jsxs("select", { id: `mc-create-${field.name}`, "aria-label": field.name, value: values[field.name] ?? '', onChange: (event) => setValues({ ...values, [field.name]: event.target.value }), children: [_jsxs("option", { value: "", children: ["\u9ED8\u8BA4", field.default == null ? '' : ` (${field.default})`] }), _jsx("option", { value: "true", children: "true" }), _jsx("option", { value: "false", children: "false" })] })) : (_jsx("input", { id: `mc-create-${field.name}`, "aria-label": field.name, required: field.required, autoComplete: "off", type: field.type === 'number' ? 'number' : 'text', placeholder: field.default == null
+                                        }, children: schema.backends.map((item) => (_jsx("option", { value: item.name, children: item.name }, item.name))) })] }), fields
+                                .filter((field) => !field.name.endsWith('_env'))
+                                .map((field) => (_jsxs("label", { className: "mc-secret-input", htmlFor: `${formId}-${field.name}`, children: [_jsxs("span", { className: "mc-input-heading", children: [_jsxs("span", { className: "mc-input-name", children: [field.name, field.required ? ' *' : ''] }), field.description && (_jsx("span", { className: "mc-input-description", children: t(datasourceDescription(field.description)) }))] }), field.type === 'boolean' ? (_jsxs("select", { id: `${formId}-${field.name}`, "aria-label": field.name, value: values[field.name] ?? '', onChange: (event) => setValues({ ...values, [field.name]: event.target.value }), children: [_jsxs("option", { value: "", children: [t('marivo.credentials.default'), field.default == null ? '' : ` (${field.default})`] }), _jsx("option", { value: "true", children: "true" }), _jsx("option", { value: "false", children: "false" })] })) : (_jsx("input", { id: `${formId}-${field.name}`, "aria-label": field.name, required: field.required, disabled: !!name && field.name === 'name', autoComplete: "off", type: field.type === 'number' ? 'number' : 'text', placeholder: field.default == null
                                             ? field.type === 'json'
                                                 ? 'JSON'
                                                 : ''
-                                            : String(field.default), value: values[field.name] ?? '', onChange: (event) => setValues({ ...values, [field.name]: event.target.value }) }))] }, field.name)))] }))] }), _jsxs("div", { className: "mc-form-footer", children: [_jsx("button", { className: "mc-primary", type: "submit", disabled: !backend || busy, children: busy ? '正在新增…' : '确认新增数据源' }), _jsx("button", { type: "button", onClick: close, disabled: busy, children: "\u53D6\u6D88" })] })] }));
+                                            : String(field.default), value: values[field.name] ?? '', onChange: (event) => setValues({ ...values, [field.name]: event.target.value }) }))] }, field.name))), credentialFields.length > 0 && (_jsxs("section", { className: "mc-inline-credentials", "aria-label": t('marivo.credentials.connection-credentials'), children: [_jsx("h4", { children: t('marivo.credentials.connection-credentials') }), _jsxs("p", { className: "mc-note", children: [t('marivo.credentials.enter-credential-values-directly-for-harness-to-save-references'), name ? t('marivo.credentials.leave-blank-to-keep-the-current-value-a-new') : ''] }), credentialFields.map((field) => (_jsxs("div", { className: "mc-credential-group", children: [credentials
+                                                .filter((row) => row.field === field.name)
+                                                .map((row) => {
+                                                const label = credentialLabel(field.name);
+                                                const reference = credentialReference(values.name ?? '', row);
+                                                return (_jsxs("div", { className: "mc-credential-entry", children: [row.key !== undefined && (_jsxs("label", { className: "mc-secret-input", children: [t('marivo.credentials.header-name'), _jsx("input", { "aria-label": t('marivo.credentials.header-name'), value: row.key, onChange: (event) => updateCredential(row.id, { key: event.target.value }) })] })), _jsxs("label", { className: "mc-secret-input", children: [_jsxs("span", { className: "mc-input-heading", children: [_jsxs("span", { className: "mc-input-name", children: [t(label), field.required ? ' *' : ''] }), _jsx("span", { className: "mc-input-description", children: row.existing
+                                                                                ? t('marivo.credentials.a-reference-is-configured-leave-blank-to-keep-it')
+                                                                                : t('marivo.credentials.enter-the-value-directly-no-need-to-create-a') })] }), _jsx("input", { "aria-label": t(label), type: "password", autoComplete: "new-password", maxLength: 65536, required: field.required && !reference, value: row.value, placeholder: row.existing
+                                                                        ? t('marivo.credentials.leave-blank-to-keep-enter-a-new-value-to')
+                                                                        : t('marivo.credentials.enter-credential-value'), onChange: (event) => updateCredential(row.id, { value: event.target.value }) })] }), _jsxs("details", { className: "mc-reference-options", children: [_jsx("summary", { children: t('marivo.credentials.credential-reference-review-or-change') }), _jsxs("label", { className: "mc-secret-input", children: [field.name, _jsx("input", { "aria-label": field.name, autoComplete: "off", value: reference, placeholder: t('marivo.credentials.generated-after-entering-a-credential-value'), onChange: (event) => updateCredential(row.id, { reference: event.target.value }) })] }), _jsx("p", { className: "mc-note", children: t('marivo.credentials.to-reuse-a-saved-credential-enter-its-reference-and') }), row.reference !== undefined && (_jsx("button", { type: "button", onClick: () => updateCredential(row.id, { reference: undefined }), children: t('marivo.credentials.restore-automatic-reference') }))] }), row.key !== undefined && (_jsx("button", { type: "button", className: "mc-quiet", onClick: () => setCredentials((rows) => rows.filter((item) => item.id !== row.id)), children: t('marivo.credentials.remove-header') }))] }, row.id));
+                                            }), field.type === 'json' && (_jsx("button", { type: "button", onClick: () => setCredentials((rows) => [
+                                                    ...rows,
+                                                    { id: crypto.randomUUID(), field: field.name, key: '', value: '' },
+                                                ]), children: t('marivo.credentials.add-header-credential') }))] }, field.name)))] }))] }))] }), _jsx("p", { className: "mc-note", children: requestId
+                    ? t('marivo.credentials.save-configuration-and-credentials-then-test-the-connection-the')
+                    : name
+                        ? t('marivo.credentials.test-the-connection-again-after-saving-name-and-engine')
+                        : '' }), _jsxs("div", { className: "mc-form-footer", children: [_jsx("button", { className: "mc-primary", type: "submit", disabled: !backend || busy, children: busy
+                            ? t('marivo.credentials.saving-or-validating')
+                            : requestId
+                                ? t('marivo.credentials.save-and-test-then-continue')
+                                : name
+                                    ? t('marivo.credentials.save-configuration')
+                                    : t('marivo.credentials.confirm-new-datasource') }), _jsx("button", { type: "button", onClick: close, disabled: busy, children: t('marivo.credentials.cancel') })] })] }));
 }

package/lib/client/credentials/credential-draft.js

@@ -0,0 +1,42 @@
+export function credentialReference(name, draft) {
+    if (draft.reference !== undefined)
+        return draft.reference.trim();
+    if (!draft.value)
+        return draft.existing ?? '';
+    const part = (value) => value
+        .toUpperCase()
+        .replace(/[^A-Z0-9_]/g, '_')
+        .slice(0, 40);
+    return `DS_${part(name) || 'CONNECTION'}_${part(draft.key ?? draft.field.replace(/_env$/, ''))}_${draft.id.replace(/-/g, '').toUpperCase()}`;
+}
+/** Values are kept separate from the public configuration, then handed to the credential operation. */
+export function prepareCredentials(name, drafts) {
+    const fields = {};
+    const changes = Object.create(null);
+    for (const draft of drafts) {
+        const ref = credentialReference(name, draft);
+        if (!ref && !draft.value)
+            continue;
+        if (!/^[A-Za-z_][A-Za-z0-9_]*$/.test(ref) ||
+            ref.length > 256 ||
+            /^(MARIVO_|DSH_DATA_ANALYSIS_|DSH_HOME$|DSH_SESSION_ID$|DSH_SESSION_JSONL$|DSH_SHELL$)/i.test(ref))
+            throw new Error('marivo.credentials.credential-references-may-contain-only-letters-numbers-and-underscores');
+        if (draft.key !== undefined) {
+            if (!draft.key.trim())
+                throw new Error('marivo.credentials.enter-the-header-name-for-this-credential');
+            fields[draft.field] ??= Object.create(null);
+            const mapping = fields[draft.field];
+            if (Object.hasOwn(mapping, draft.key))
+                throw new Error('marivo.credentials.header-names-must-be-unique');
+            mapping[draft.key] = ref;
+        }
+        else
+            fields[draft.field] = ref;
+        if (draft.value) {
+            if (changes[ref] !== undefined && changes[ref] !== draft.value)
+                throw new Error('marivo.credentials.the-same-credential-reference-cannot-have-different-values');
+            changes[ref] = draft.value;
+        }
+    }
+    return { fields, changes };
+}

package/lib/client/credentials/defaults.js

@@ -0,0 +1,11 @@
+export function creationFieldValues(schema, backend) {
+    const defaults = schema.creationDefaults?.[backend] ?? {};
+    return Object.fromEntries((schema.backends.find((item) => item.name === backend)?.fields ?? [])
+        .filter((field) => !field.name.endsWith('_env') && Object.hasOwn(defaults, field.name))
+        .map((field) => [
+        field.name,
+        field.type === 'string'
+            ? defaults[field.name]
+            : JSON.stringify(defaults[field.name]),
+    ]));
+}

package/lib/client/credentials/descriptions.js

@@ -0,0 +1,46 @@
+// Presentation-only translations of public Runtime descriptions, not a field schema.
+// Match the complete source text so changed or newly added descriptions retain their meaning.
+const descriptions = {
+    'Global datasource name; letters, digits, underscores, and hyphens only.': 'marivo.credentials.global-datasource-name-use-only-letters-numbers-underscores-and',
+    'Rare JSON-safe ibis keyword arguments not modeled by the typed class.': 'marivo.credentials.additional-connection-parameters-for-ibis-options-not-listed-in',
+    'DuckDB database path; defaults to in-memory.': 'marivo.credentials.duckdb-database-file-path-defaults-to-an-in-memory',
+    'SQLite database path; defaults to in-memory.': 'marivo.credentials.sqlite-database-file-path-defaults-to-an-in-memory',
+    'Open the DuckDB database in read-only mode.': 'marivo.credentials.open-the-duckdb-database-in-read-only-mode',
+    'Open the SQLite database in query-only mode.': 'marivo.credentials.open-the-sqlite-database-in-query-only-mode',
+    'Optional mapping from declared SQLite type names to Ibis type strings.': 'marivo.credentials.optional-mapping-from-sqlite-declared-type-names-to-ibis',
+    'Optional HTTP(S) URL prefix for scoped remote JSON auth.': 'marivo.credentials.optional-http-s-url-prefix-where-remote-json-requests',
+    'Environment variable for a scoped HTTP bearer token.': 'marivo.credentials.credential-reference-for-the-http-bearer-token-within-the',
+    'Optional custom HTTP header names mapped to secret environment variables.': 'marivo.credentials.optional-mapping-from-custom-http-header-names-to-credential',
+    'Trino coordinator host.': 'marivo.credentials.trino-coordinator-host-address',
+    'Trino catalog; mapped to ibis database at connect time.': 'marivo.credentials.trino-catalog-name-mapped-to-the-ibis-database-parameter',
+    'Required environment variable for the Trino user.': 'marivo.credentials.required-credential-reference-for-the-trino-username',
+    'Trino port; ibis default is 8080.': 'marivo.credentials.trino-port-ibis-defaults-to-8080',
+    'Optional default schema.': 'marivo.credentials.optional-default-schema-name',
+    'Optional client application/source tag.': 'marivo.credentials.optional-client-application-or-request-source-identifier',
+    'Optional engine session timezone.': 'marivo.credentials.optional-database-session-timezone',
+    "Set to 'https' for TLS.": 'marivo.credentials.enter-https-to-enable-tls-encryption',
+    'Optional Trino client tags.': 'marivo.credentials.optional-trino-client-tags-as-a-json-array',
+    'Optional Trino session properties.': 'marivo.credentials.optional-trino-session-properties-as-a-json-object',
+    'Environment variable for Trino auth token or password.': 'marivo.credentials.credential-reference-for-the-trino-token-or-password',
+    'MySQL host.': 'marivo.credentials.mysql-server-host-address',
+    'MySQL database name.': 'marivo.credentials.mysql-database-name',
+    'MySQL port; ibis default is 3306.': 'marivo.credentials.mysql-port-ibis-defaults-to-3306',
+    'Optional autocommit override.': 'marivo.credentials.optional-setting-for-automatic-transaction-commits',
+    'Environment variable for MySQL user.': 'marivo.credentials.credential-reference-for-the-mysql-username',
+    'Environment variable for MySQL password.': 'marivo.credentials.credential-reference-for-the-mysql-password',
+    'Postgres host.': 'marivo.credentials.postgresql-server-host-address',
+    'Postgres database name.': 'marivo.credentials.postgresql-database-name',
+    'Postgres port; ibis default is 5432.': 'marivo.credentials.postgresql-port-ibis-defaults-to-5432',
+    'Environment variable for Postgres user.': 'marivo.credentials.credential-reference-for-the-postgresql-username',
+    'Environment variable for Postgres password.': 'marivo.credentials.credential-reference-for-the-postgresql-password',
+    'ClickHouse host.': 'marivo.credentials.clickhouse-server-host-address',
+    'ClickHouse port; native default is 9000, secure default is 9440.': 'marivo.credentials.clickhouse-port-native-connections-default-to-9000-secure-connections',
+    "ClickHouse database; ibis default is 'default'.": 'marivo.credentials.clickhouse-database-name-ibis-defaults-to-default',
+    'Enable TLS for ClickHouse.': 'marivo.credentials.enable-tls-encryption-for-clickhouse',
+    'Optional ClickHouse settings map.': 'marivo.credentials.optional-clickhouse-settings-as-a-json-object',
+    'Environment variable for ClickHouse user.': 'marivo.credentials.credential-reference-for-the-clickhouse-username',
+    'Environment variable for ClickHouse password.': 'marivo.credentials.credential-reference-for-the-clickhouse-password',
+};
+export function datasourceDescription(description) {
+    return descriptions[description] ?? description;
+}