@galadrim/galadmin 0.2.9 → 0.2.11-alpha.1.1

package/.agents/skills/port-javascript-to-typescript/scripts/oxlint.json

@@ -0,0 +1,14 @@
+{
+  "plugins": ["typescript"],
+  "categories": { "correctness": "off" },
+  "rules": {
+    "typescript/no-explicit-any": "warn",
+    "typescript/no-non-null-assertion": "warn",
+    "typescript/ban-ts-comment": ["warn", {
+      "ts-ignore": true,
+      "ts-expect-error": true,
+      "ts-nocheck": true,
+      "ts-check": false
+    }]
+  }
+}

package/.agents/skills/port-javascript-to-typescript/scripts/test-tools.cjs

@@ -0,0 +1,76 @@
+const assert = require('node:assert/strict');
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
+const { spawnSync } = require('node:child_process');
+
+const temporary = fs.mkdtempSync(path.join(os.tmpdir(), 'port tools '));
+const tools = path.join(temporary, 'copied skill');
+const repo = path.join(temporary, 'target repo');
+fs.cpSync(__dirname, tools, { recursive: true });
+fs.mkdirSync(repo);
+
+function run(script, args, status = 0) {
+  const result = spawnSync('bash', [path.join(tools, script), ...args], {
+    cwd: repo, encoding: 'utf8', timeout: 120000,
+  });
+  assert.ifError(result.error);
+  assert.equal(result.status, status, result.stderr + result.stdout);
+  return result;
+}
+
+try {
+  const inputs = {
+    'tsconfig.json': JSON.stringify({ compilerOptions: {
+      baseUrl: '.', paths: { '@left': ['./left.ts'] }, allowJs: true,
+    } }),
+    'package.json': JSON.stringify({ madge: { excludeRegExp: ['.*'] } }),
+    'entry.ts': 'import { left } from "@left"; import type { Value } from "./types";\n'
+      + 'const common = require("./common.cjs"); import("./dynamic");\n',
+    'left.ts': 'import "./right"; export const left = 1;',
+    'right.ts': 'import "./left";',
+    'types.ts': 'export type Value = string;',
+    'common.cjs': 'module.exports = 1;',
+    'dynamic.ts': 'export const dynamic = 1;',
+    'missing.ts': 'import "./does-not-exist";',
+    'warnings.ts': 'let value: any;\nvalue!.field;\n'
+      + '// @ts-expect-error documented suppression\nvalue.call();\n'
+      + '// @ts-check\nconst unused = 1; debugger;\n',
+    '.oxlintrc.json': JSON.stringify({ rules: {
+      'typescript/no-explicit-any': 'off', 'no-unused-vars': 'error',
+    } }),
+    '.eslintignore': 'warnings.ts\n',
+    'broken.ts': 'const = ;',
+  };
+  for (const [file, content] of Object.entries(inputs)) {
+    fs.writeFileSync(path.join(repo, file), content);
+  }
+  for (const script of ['graph.sh', 'check.sh']) {
+    run(script, ['--help']);
+    run(script, [], 2);
+  }
+  const graph = JSON.parse(run('graph.sh', ['tsconfig.json', 'entry.ts']).stdout);
+  assert.deepEqual(graph['entry.ts'], ['common.cjs', 'dynamic.ts', 'left.ts', 'types.ts']);
+  assert.deepEqual(graph['left.ts'], ['right.ts']);
+  assert.deepEqual(graph['right.ts'], ['left.ts']);
+  const missing = run('graph.sh', ['tsconfig.json', 'missing.ts']);
+  assert.match(missing.stderr, /does-not-exist/);
+  assert.deepEqual(JSON.parse(missing.stdout)['missing.ts'], []);
+  run('graph.sh', ['tsconfig.json', 'absent.ts'], 1);
+
+  const lint = JSON.parse(run('check.sh', ['warnings.ts']).stdout);
+  assert.equal(lint.number_of_files, 1);
+  assert.equal(lint.diagnostics.length, 3);
+  assert.ok(lint.diagnostics.every(diagnostic => diagnostic.severity === 'warning'));
+  for (const rule of ['no-explicit-any', 'no-non-null-assertion', 'ban-ts-comment']) {
+    assert.ok(lint.diagnostics.some(diagnostic => diagnostic.code.includes(rule)), rule);
+  }
+  run('check.sh', ['broken.ts'], 1);
+  run('check.sh', ['absent.ts'], 1);
+  for (const [file, content] of Object.entries(inputs)) {
+    assert.equal(fs.readFileSync(path.join(repo, file), 'utf8'), content);
+  }
+  console.log('Tool integration checks passed.');
+} finally {
+  fs.rmSync(temporary, { recursive: true, force: true });
+}

package/.github/actions/version-bump/action.yml

@@ -0,0 +1,41 @@
+name: 'Automated Version Bump'
+description: >-
+  Bumps the package version, commits package.json + package-lock.json,
+  tags the result and pushes both to the current branch.
+  Requires a checkout with persisted credentials and a job granting
+  `permissions: contents: write`.
+
+inputs:
+  version-type:
+    description: 'SemVer release type: patch, minor or major'
+    required: false
+    default: 'patch'
+
+outputs:
+  version:
+    description: 'The new version, without the v prefix (e.g. 0.2.12)'
+    value: ${{ steps.bump.outputs.version }}
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Configure git author
+      shell: bash
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+    - name: Bump, commit and tag
+      id: bump
+      shell: bash
+      run: |
+        VERSION=$(npm version "${{ inputs.version-type }}" --no-git-tag-version)
+        VERSION="${VERSION#v}"
+        echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+        git add package.json package-lock.json
+        git commit -m "ci: version bump to $VERSION"
+        git tag "$VERSION"
+
+    - name: Push commit and tag
+      shell: bash
+      run: git push origin "HEAD:${{ github.ref_name }}" "${{ steps.bump.outputs.version }}"

package/.github/workflows/alpha.yml

@@ -0,0 +1,53 @@
+name: Publish alpha
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: alpha-publish
+
+jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
+  build-and-publish-alpha:
+    needs: test
+    runs-on: ubicloud-standard-2
+    env:
+      CI: false
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: 22
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+          cache-dependency-path: |
+            package-lock.json
+            src/front/package-lock.json
+      - name: Compute alpha version
+        run: |
+          BASE=$(node -p "require('./package.json').version")
+          npm version "$BASE-alpha.${{ github.run_number }}.${{ github.run_attempt }}" --no-git-tag-version --allow-same-version
+      - name: Dependencies installation
+        run: npm ci
+      - name: Front-end - Dependencies installation
+        run: npm ci
+        working-directory: ./src/front
+      - name: Front-end - Generate build
+        run: npm run build
+        working-directory: ./src/front
+      - name: Generate build
+        run: npm run build
+      - name: Publish package
+        run: npm publish --tag alpha
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Verify dist-tags
+        run: npm view @galadrim/galadmin dist-tags --json
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  pull_request:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubicloud-standard-2
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: 22
+          cache: 'npm'
+          cache-dependency-path: |
+            package-lock.json
+            src/front/package-lock.json
+      - name: Dependencies installation
+        run: npm ci
+      - name: Front-end - Dependencies installation
+        run: npm ci
+        working-directory: ./src/front
+      # The root tsconfig includes the custom CKEditor source under src/front.
+      - name: Typecheck
+        run: npm run typecheck
+      - name: Run unit tests
+        run: npm test
+      - name: Run integration tests (real MySQL/PostgreSQL via testcontainers)
+        run: npm run test:integration
+        env:
+          TEST_INTEGRATION: '1'
+      - name: Run front-end tests
+        run: npm test -- --watchAll=false
+        working-directory: ./src/front

package/.github/workflows/main.yml

@@ -6,61 +6,33 @@ on:
 
 jobs:
   test:
-    runs-on: ubicloud-standard-2
-    env:
-      CI: false
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 22
-      - name: Dependencies installation
-        run: npm install
-      - name: Run unit tests
-        run: npm test
-      - name: Run integration tests (real MySQL/PostgreSQL via testcontainers)
-        run: npm run test:integration
-        env:
-          TEST_INTEGRATION: '1'
-      - name: Front-end - Load cache
-        uses: actions/cache@v4
-        with:
-          path: '**/src/front/node_modules'
-          key: ${{ runner.os }}-npm-front-${{ hashFiles('**/src/front/package-lock.json') }}
-      - name: Front-end - Dependencies installation
-        run: npm install
-        working-directory: ./src/front
-      - name: Run front-end tests
-        run: npm test -- --watchAll=false
-        working-directory: ./src/front
+    uses: ./.github/workflows/ci.yml
 
   build-and-deploy:
     needs: test
     runs-on: ubicloud-standard-2
+    permissions:
+      contents: write
     env:
       CI: false
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
-      - uses: actions/setup-node@v3
+        uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
         with:
           node-version: 22
+          cache: 'npm'
+          cache-dependency-path: |
+            package-lock.json
+            src/front/package-lock.json
       - name: 'Automated Version Bump'
-        uses: 'phips28/gh-action-bump-version@master'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: ./.github/actions/version-bump
         with:
-          version-type:  'patch'
+          version-type: 'patch'
       - name: Dependencies installation
-        run: npm install
-      - name: Front-end - Load cache
-        uses: actions/cache@v4
-        with:
-          path: '**/src/front/node_modules'
-          key: ${{ runner.os }}-npm-front-${{ hashFiles('**/src/front/package-lock.json') }}
+        run: npm ci
       - name: Front-end - Dependencies installation
-        run: npm install
+        run: npm ci
         working-directory: ./src/front
       - name: Front-end - Generate build
         run: npm run build
@@ -68,6 +40,6 @@ jobs:
       - name: Generate build
         run: npm run build
       - name: Publish package
-        uses: JS-DevTools/npm-publish@v1
+        uses: JS-DevTools/npm-publish@v4
         with:
           token: ${{ secrets.NPM_TOKEN }}

package/AGENTS.md

@@ -0,0 +1,5 @@
+# Testing
+
+- When adding tests, keep mocks to the minimum necessary.
+- Never mock the database.
+- If a test would require mocking, extend the integration tests instead.

package/README.md

@@ -229,6 +229,7 @@ upload of a file onto AWS S3. A basic configuration would be as follow:
     dataType: 'file',
     s3Config: {
       host: process.env.AWS_S3_HOST,
+      /** Optional. When omitted, the AWS SDK default credential chain is used. */
       accessKeyId: process.env.AWS_ACCESS_KEY_ID,
       secretAccessKey: process.env.AWS_SECRET_KEY,
       bucket: process.env.AWS_S3_PODCAST_BUCKET_NAME,
@@ -240,6 +241,35 @@ upload of a file onto AWS S3. A basic configuration would be as follow:
   }]
 ```
 
+When `accessKeyId` is omitted or empty, the AWS SDK will try to resolve the credentials itself (first match wins):
+
+1. Env vars AWS_ACCESS_KEY_ID + AWS_SECRET_ACCESS_KEY (+ AWS_SESSION_TOKEN), skipped if AWS_PROFILE is set
+2. Profile AWS_PROFILE (or "default") from ~/.aws/config and ~/.aws/credentials (SSO, static keys, assumed role, credential_process)
+3. Web identity token: AWS_WEB_IDENTITY_TOKEN_FILE + AWS_ROLE_ARN (e.g. EKS)
+4. ECS container role: AWS_CONTAINER_CREDENTIALS_RELATIVE_URI or AWS_CONTAINER_CREDENTIALS_FULL_URI
+5. EC2 instance role via the instance metadata service, unless AWS_EC2_METADATA_DISABLED is set to anything but `false`
+
+It's recommended to rely on a role rather than have long-lived AWS credentials added to the server: the instance profile role on EC2/Elastic Beanstalk, or the task role (not the execution role) on ECS/Fargate. Add the following permissions to that role:
+
+```
+{
+  "Version": "2012-10-17",
+  "Statement": [{
+    "Effect": "Allow",
+    "Action": [
+      "s3:PutObject",
+      "s3:PutObjectAcl"
+    ],
+    "Resource": "arn:aws:s3:::<bucket>/<subfolder>/*"
+  }]
+}
+```
+
+- Without `subfolder`, use `arn:aws:s3:::<bucket>/*` as the resource.
+- By default, files are uploaded with a `public-read` ACL, so the bucket must allow ACLs: its Object Ownership must not be "Bucket owner enforced" (otherwise `AccessControlListNotSupported`), and `BlockPublicAcls` must be off (otherwise `AccessDenied`).
+- With `signedUrlNeeded: true`, no ACL is set: only `s3:PutObject` is needed and the bucket can stay private.
+- If the bucket is encrypted with SSE-KMS, also allow `kms:GenerateDataKey` on its KMS key.
+
 ### File upload on Google Cloud Platform (GCP)
 
 You can also use the FileColumn to upload files to Google Cloud Storage. To use GCP instead of AWS S3, configure the gcpConfig as follows:
@@ -302,6 +332,7 @@ engines (see below); the unit suite covers pure logic and configuration wiring
 without any database.
 
 ```bash
+npm run typecheck       # check backend TypeScript without emitting build files
 npm test                # run the unit suite (no database required)
 npm run test:watch      # watch mode
 npm run test:coverage   # unit + integration merged report (Docker required)
@@ -323,6 +354,12 @@ npm run test:all           # unit suite + integration suite
 reachable Docker daemon and fails without one, so a broken Docker setup in CI
 cannot pass silently.
 
+The `CI` GitHub Actions workflow runs typechecking, backend unit and integration
+tests, and frontend tests on pull requests. The deployment workflow reuses the
+same workflow and only builds and publishes after it passes. To require these
+checks before merging, configure the CI test check as required in the target
+branch's protection rules.
+
 ### Known robustness limitations
 
 The former `tests/security-known-gaps.test.ts` suite encoded unfixed security
@@ -334,14 +371,14 @@ them.
 A few robustness limitations remain documented (not assertable over HTTP
 because the error escapes as an unhandled rejection under express 4):
 
-* A throwing `parseImportFile` in `/recordsImport` or `/subrecordsImport` is
+- A throwing `parseImportFile` in `/recordsImport` or `/subrecordsImport` is
   awaited OUTSIDE the try/catch of the multiparty callback — the 500 is never
   sent and the process can crash.
-* `formatValueForInsertion(false)` returns `"NULL"`, so a boolean `false`
+- `formatValueForInsertion(false)` returns `"NULL"`, so a boolean `false`
   cannot be imported.
-* The local-fs upload backend requires `subdirectory` (publicPath +
+- The local-fs upload backend requires `subdirectory` (publicPath +
   undefined concat yields a nonexistent upload dir).
-* A throwing `editCallbackFunction` in `/updateRecord` is awaited OUTSIDE any
+- A throwing `editCallbackFunction` in `/updateRecord` is awaited OUTSIDE any
   try/catch — the update is committed but the request hangs forever.
 
 ### Frontend tests

package/dist/api/authorization.d.ts

@@ -0,0 +1,38 @@
+import type { BaseTypeView, TablePanel } from "../types/config";
+type SessionRequest = {
+    session?: object;
+};
+type WritableView = Pick<BaseTypeView, "roles"> & Pick<TablePanel, "tableName"> & {
+    recordViewPanels?: (Pick<TablePanel, "tableName"> & {
+        createConfig?: Pick<TablePanel, "tableName">;
+    })[];
+};
+export declare const ROOT_ROLE = "root";
+export declare const roleOf: (req: SessionRequest) => string | undefined;
+export declare const canWriteView: (view: Pick<BaseTypeView, "roles"> | undefined, role: string | undefined) => boolean;
+export declare const viewFromRequest: <T = WritableView>(req: {
+    body?: {
+        viewIndex?: unknown;
+    };
+    query?: {
+        viewIndex?: unknown;
+    };
+    config?: {
+        views?: T[];
+    };
+}) => T | undefined;
+export declare const MUTATING_VIEW_ROUTES: Set<string>;
+export declare const areSafeColumnNames: (data: unknown) => boolean;
+export declare const writableTables: (req: SessionRequest & {
+    config?: {
+        views?: WritableView[];
+    };
+}) => Set<string>;
+export declare const looksLikeSqlBreakout: (frag: unknown) => boolean;
+type HiddenColumnsView = {
+    __hiddenColumns?: string[];
+};
+export declare const hiddenColumnsOf: (view: HiddenColumnsView | undefined) => string[];
+export declare const stripHiddenColumns: <T extends Record<string, unknown>>(view: HiddenColumnsView | undefined, record: T) => T;
+export declare const touchesHiddenColumn: (view: HiddenColumnsView | undefined, data: unknown) => boolean;
+export {};

package/dist/api/authorization.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.touchesHiddenColumn = exports.stripHiddenColumns = exports.hiddenColumnsOf = exports.looksLikeSqlBreakout = exports.writableTables = exports.areSafeColumnNames = exports.MUTATING_VIEW_ROUTES = exports.viewFromRequest = exports.canWriteView = exports.roleOf = exports.ROOT_ROLE = void 0;
+exports.ROOT_ROLE = "root";
+const roleOf = (req) => {
+    const user = req.session && Reflect.get(req.session, "user");
+    if (!user || typeof user !== "object")
+        return undefined;
+    const role = Reflect.get(user, "role");
+    return typeof role === "string" ? role : undefined;
+};
+exports.roleOf = roleOf;
+const canWriteView = (view, role) => role === exports.ROOT_ROLE || !view || !view.roles || (role !== undefined && view.roles.includes(role));
+exports.canWriteView = canWriteView;
+const viewFromRequest = (req) => {
+    const idx = req.body && req.body.viewIndex !== undefined
+        ? req.body.viewIndex
+        : req.query && req.query.viewIndex !== undefined
+            ? req.query.viewIndex
+            : undefined;
+    if (idx === undefined || !req.config || !req.config.views)
+        return undefined;
+    const key = String(idx);
+    const index = Number(key);
+    if (!Number.isInteger(index) || index < 0 || index >= req.config.views.length || String(index) !== key) {
+        return undefined;
+    }
+    return req.config.views[index];
+};
+exports.viewFromRequest = viewFromRequest;
+exports.MUTATING_VIEW_ROUTES = new Set([
+    "/updateRecord",
+    "/createRecord",
+    "/deleteRecord",
+    "/deleteRecords",
+    "/deleteRecordFromPanel",
+    "/customAction",
+    "/uploadFile",
+]);
+const areSafeColumnNames = (data) => !data || Object.keys(data).every((k) => /^[A-Za-z0-9_]+$/.test(k));
+exports.areSafeColumnNames = areSafeColumnNames;
+const writableTables = (req) => {
+    var _a, _b;
+    const role = (0, exports.roleOf)(req);
+    const tables = new Set();
+    for (const view of ((_a = req.config) === null || _a === void 0 ? void 0 : _a.views) || []) {
+        if (!(0, exports.canWriteView)(view, role))
+            continue;
+        if (view.tableName)
+            tables.add(view.tableName);
+        for (const panel of view.recordViewPanels || []) {
+            if (panel.tableName)
+                tables.add(panel.tableName);
+            if ((_b = panel.createConfig) === null || _b === void 0 ? void 0 : _b.tableName)
+                tables.add(panel.createConfig.tableName);
+        }
+    }
+    return tables;
+};
+exports.writableTables = writableTables;
+const looksLikeSqlBreakout = (frag) => typeof frag === "string" &&
+    /(;|--|\/\*|\bunion\b|\binto\s+(out|dump)file\b|\bsleep\s*\(|\bbenchmark\s*\(|\bload_file\s*\()/i.test(frag);
+exports.looksLikeSqlBreakout = looksLikeSqlBreakout;
+const hiddenColumnsOf = (view) => (view && view.__hiddenColumns) || [];
+exports.hiddenColumnsOf = hiddenColumnsOf;
+const stripHiddenColumns = (view, record) => {
+    for (const name of (0, exports.hiddenColumnsOf)(view))
+        delete record[name];
+    return record;
+};
+exports.stripHiddenColumns = stripHiddenColumns;
+const touchesHiddenColumn = (view, data) => (0, exports.hiddenColumnsOf)(view).some((name) => data && Object.prototype.hasOwnProperty.call(data, name));
+exports.touchesHiddenColumn = touchesHiddenColumn;
+//# sourceMappingURL=authorization.js.map

package/dist/api/authorization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.js","sourceRoot":"","sources":["../../src/api/authorization.ts"],"names":[],"mappings":";;;AAmBa,QAAA,SAAS,GAAG,MAAM,CAAC;AAKzB,MAAM,MAAM,GAAG,CAAC,GAAmB,EAAE,EAAE;IAC5C,MAAM,IAAI,GAAY,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACtE,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IACxD,MAAM,IAAI,GAAY,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChD,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC,CAAC;AALW,QAAA,MAAM,UAKjB;AAEK,MAAM,YAAY,GAAG,CAAC,IAA6C,EAAE,IAAwB,EAAE,EAAE,CACtG,IAAI,KAAK,iBAAS,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AADrF,QAAA,YAAY,gBACyE;AAE3F,MAAM,eAAe,GAAG,CAAmB,GAIjD,EAAiB,EAAE;IAClB,MAAM,GAAG,GACP,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS;QAC1C,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS;QACpB,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS;YAC9C,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS;YACrB,CAAC,CAAC,SAAS,CAAC;IAClB,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAM5E,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IACxB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;QACvG,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC,CAAC;AAvBW,QAAA,eAAe,mBAuB1B;AAKW,QAAA,oBAAoB,GAAG,IAAI,GAAG,CAAC;IAC1C,eAAe;IACf,eAAe;IACf,eAAe;IACf,gBAAgB;IAChB,wBAAwB;IACxB,eAAe;IACf,aAAa;CACd,CAAC,CAAC;AAMI,MAAM,kBAAkB,GAAG,CAAC,IAAa,EAAE,EAAE,CAClD,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AADxD,QAAA,kBAAkB,sBACsC;AAI9D,MAAM,cAAc,GAAG,CAAC,GAA6D,EAAE,EAAE;;IAC9F,MAAM,IAAI,GAAG,IAAA,cAAM,EAAC,GAAG,CAAC,CAAC;IACzB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,KAAK,MAAM,IAAI,IAAI,CAAA,MAAA,GAAG,CAAC,MAAM,0CAAE,KAAK,KAAI,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAA,oBAAY,EAAC,IAAI,EAAE,IAAI,CAAC;YAAE,SAAS;QACxC,IAAI,IAAI,CAAC,SAAS;YAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,gBAAgB,IAAI,EAAE,EAAE,CAAC;YAChD,IAAI,KAAK,CAAC,SAAS;gBAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACjD,IAAI,MAAA,KAAK,CAAC,YAAY,0CAAE,SAAS;gBAC/B,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAbW,QAAA,cAAc,kBAazB;AAKK,MAAM,oBAAoB,GAAG,CAAC,IAAa,EAAE,EAAE,CACpD,OAAO,IAAI,KAAK,QAAQ;IACxB,iGAAiG,CAAC,IAAI,CACpG,IAAI,CACL,CAAC;AAJS,QAAA,oBAAoB,wBAI7B;AAKG,MAAM,eAAe,GAAG,CAC7B,IAAmC,EACnC,EAAE,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;AAF7B,QAAA,eAAe,mBAEc;AAGnC,MAAM,kBAAkB,GAAG,CAChC,IAAmC,EACnC,MAAS,EACT,EAAE;IACF,KAAK,MAAM,IAAI,IAAI,IAAA,uBAAe,EAAC,IAAI,CAAC;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9D,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AANW,QAAA,kBAAkB,sBAM7B;AAGK,MAAM,mBAAmB,GAAG,CACjC,IAAmC,EACnC,IAAa,EACb,EAAE,CACF,IAAA,uBAAe,EAAC,IAAI,CAAC,CAAC,IAAI,CACxB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CACnE,CAAC;AANS,QAAA,mBAAmB,uBAM5B"}

package/dist/api/config.d.ts

@@ -0,0 +1,42 @@
+import type { BaseTypeColumn, Config, FileUploadProperties, RichTextColumn, SelectColumn, StandardColumn, Subview, View } from "../types/config";
+import type dbManager from "../utils/dbManager";
+type Identified = {
+    __id__?: string;
+};
+type EnrichmentColumn = StandardColumn & Pick<BaseTypeColumn, "required"> & Pick<RichTextColumn, "contentField"> & Pick<FileUploadProperties, "s3Config" | "gcpConfig"> & Partial<Pick<SelectColumn, "options">> & Identified & {
+    baseUrl?: string;
+};
+type EnrichmentView = Identified & {
+    subviews?: (Subview & Identified)[];
+} & ({
+    type: "table";
+    tableName: string;
+    primaryId?: string;
+    columns: EnrichmentColumn[];
+    recordViewPanels?: (Identified & {
+        type: string;
+        createConfig?: {
+            columns: EnrichmentColumn[];
+        };
+    })[];
+} | {
+    type: Exclude<View["type"], "table">;
+});
+type EnrichmentConfig = Pick<Config, "mysql" | "postgresql" | "enriched"> & {
+    views: EnrichmentView[];
+};
+type SchemaColumn = {
+    TABLE_NAME?: string;
+    COLUMN_NAME?: string;
+    COLUMN_KEY?: string;
+    IS_NULLABLE?: string;
+    DATA_TYPE?: string;
+    COLUMN_TYPE?: string;
+};
+type SchemaDatabase = {
+    query(...args: Parameters<dbManager["query"]>): Promise<Partial<Pick<Awaited<ReturnType<dbManager["query"]>>, "err" | "rows">>>;
+};
+export declare function generateUniqueIdForObject(obj: unknown): string;
+export declare function enrichConfig(config: EnrichmentConfig, db: SchemaDatabase): Promise<void>;
+export declare function enrichColumn(column: EnrichmentColumn, tableName: string, info: SchemaColumn[]): void;
+export {};

package/dist/api/config.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateUniqueIdForObject = generateUniqueIdForObject;
+exports.enrichConfig = enrichConfig;
+exports.enrichColumn = enrichColumn;
+const crypto = require("crypto");
+function readSchemaColumns(value) {
+    if (!Array.isArray(value) || !value.every((row) => row !== null && typeof row === "object" && !Array.isArray(row)
+        && (!("TABLE_NAME" in row) || typeof row.TABLE_NAME === "string")
+        && (!("COLUMN_NAME" in row) || typeof row.COLUMN_NAME === "string")
+        && (!("COLUMN_KEY" in row) || typeof row.COLUMN_KEY === "string")
+        && (!("IS_NULLABLE" in row) || typeof row.IS_NULLABLE === "string")
+        && (!("DATA_TYPE" in row) || typeof row.DATA_TYPE === "string")
+        && (!("COLUMN_TYPE" in row) || typeof row.COLUMN_TYPE === "string")))
+        throw new TypeError("Invalid database schema columns");
+    return value;
+}
+function readEnumOptions(columnType) {
+    if (columnType === undefined)
+        throw new TypeError("Missing enum column type");
+    const options = JSON.parse(columnType.replace("enum(", "[").replace(")", "]").replace(/'/g, '"'));
+    if (!Array.isArray(options) || !options.every((option) => typeof option === "string")) {
+        throw new TypeError("Invalid enum options");
+    }
+    return options;
+}
+function generateUniqueIdForObject(obj) {
+    const str = JSON.stringify(obj);
+    const hash = crypto.createHash("sha256").update(str).digest("hex");
+    return hash;
+}
+async function enrichConfig(config, db) {
+    var _a, _b;
+    const { rows, err = null } = await db.query("SELECT * FROM information_schema.columns WHERE table_schema = ?", [((_a = config.mysql) === null || _a === void 0 ? void 0 : _a.database) || ((_b = config.postgresql) === null || _b === void 0 ? void 0 : _b.database)]);
+    if (err) {
+        console.error(err);
+        return;
+    }
+    const info = readSchemaColumns(rows);
+    for (const view of config.views) {
+        if (view.type == "table") {
+            const tableName = view.tableName;
+            for (const infoEl of info) {
+                if (infoEl.TABLE_NAME == tableName && infoEl.COLUMN_KEY == "PRI") {
+                    view.primaryId = infoEl.COLUMN_NAME;
+                }
+            }
+            for (const column of view.columns) {
+                enrichColumn(column, tableName, info);
+            }
+            if (view.recordViewPanels) {
+                for (const panel of view.recordViewPanels) {
+                    if (panel.createConfig) {
+                        for (const column of panel.createConfig.columns) {
+                            enrichColumn(column, tableName, info);
+                        }
+                    }
+                    if (!panel.__id__) {
+                        panel.__id__ = generateUniqueIdForObject(panel);
+                    }
+                }
+            }
+        }
+        if (view.subviews) {
+            for (const subview of view.subviews) {
+                if (!subview.__id__) {
+                    subview.__id__ = generateUniqueIdForObject(subview);
+                }
+            }
+        }
+        if (!view.__id__) {
+            view.__id__ = generateUniqueIdForObject(view);
+        }
+    }
+    config.enriched = true;
+}
+function enrichColumn(column, tableName, info) {
+    var _a, _b, _c, _d;
+    if (!column.__id__) {
+        column.__id__ = generateUniqueIdForObject(column);
+    }
+    const infoEl = info.find((x) => x.TABLE_NAME == tableName && x.COLUMN_NAME == column.name);
+    if ((infoEl === null || infoEl === void 0 ? void 0 : infoEl.IS_NULLABLE) == "NO" &&
+        (infoEl === null || infoEl === void 0 ? void 0 : infoEl.DATA_TYPE) != "text" &&
+        column.required !== true &&
+        column.required !== false) {
+        column.required = true;
+    }
+    if (!column.dataType && infoEl) {
+        column.dataType = infoEl.DATA_TYPE;
+        if (column.dataType == "enum") {
+            column.dataType = "select";
+            column.options = readEnumOptions(infoEl.COLUMN_TYPE);
+        }
+    }
+    if (column.dataType == "richText") {
+        column.name = column.contentField;
+    }
+    if (column.dataType == "file" && (column.s3Config || column.gcpConfig)) {
+        const host = ((_a = column.s3Config) === null || _a === void 0 ? void 0 : _a.host) || ((_b = column.gcpConfig) === null || _b === void 0 ? void 0 : _b.host);
+        const bucket = ((_c = column.s3Config) === null || _c === void 0 ? void 0 : _c.bucket) || ((_d = column.gcpConfig) === null || _d === void 0 ? void 0 : _d.bucket);
+        column.baseUrl = `https://${host}/${bucket}/`;
+    }
+}
+//# sourceMappingURL=config.js.map