@comet/admin-generator 8.17.1 → 9.0.0-beta.0

package/lib/commands/generate/generate-command.d.ts

@@ -1,340 +0,0 @@
-import { type ApolloClient } from "@apollo/client";
-import { type GridColDef } from "@comet/admin";
-import { type IconName } from "@comet/admin-icons";
-import { type BlockInterface, type ContentScope, type FinalFormFileUploadProps } from "@comet/cms-admin";
-import { type IconProps } from "@mui/material";
-import { type GridCellParams, type GridFilterItem, type GridFilterOperator, type GridRenderCellParams, type GridSortDirection, type GridValidRowModel } from "@mui/x-data-grid";
-import { Command } from "commander";
-import { type FieldValidator, type FormApi } from "final-form";
-import type { ComponentType, ReactElement } from "react";
-import type { FormattedMessage, MessageDescriptor } from "react-intl";
-import { type UsableFields, type UsableFormFields } from "./generateGrid/usableFields";
-import { type ColumnVisibleOption } from "./utils/columnVisibility";
-export type FormattedMessageElement = ReactElement<MessageDescriptor, typeof FormattedMessage>;
-type IconObject = Pick<IconProps, "color" | "fontSize"> & {
-    name: IconName;
-};
-type Icon = IconName | IconObject | ComponentType;
-export type Adornment = string | {
-    icon: Icon;
-};
-type InputBaseFieldConfig = {
-    startAdornment?: Adornment;
-    endAdornment?: Adornment;
-};
-export type ComponentFormFieldConfig = {
-    type: "component";
-    component: ComponentType;
-};
-export type StaticSelectValue = {
-    value: string;
-    label: string | FormattedMessageElement;
-} | string;
-type AsyncSelectFilter = {
-    /**
-     * Filter by value of field in current form
-     */
-    type: "field";
-    /**
-     * Name of the field in current form, that will be used to filter the query
-     */
-    formFieldName: string;
-    /**
-     * Name of the graphql argument the prop will be applied to. Defaults to propdName.
-     *
-     * Root Argument or filter argument are supported.
-     */
-    rootQueryArg?: string;
-} | {
-    /**
-     * Filter by a prop passed into the form, this prop will be generated
-     */
-    type: "formProp";
-    /**
-     * Name of the prop generated for this form
-     */
-    propName: string;
-    /**
-     * Name of the graphql argument the prop will be applied to. Defaults to propdName.
-     *
-     * Root Argument or filter argument are supported.
-     */
-    rootQueryArg?: string;
-};
-export type FormFieldConfig<T> = (({
-    type: "text";
-    name: UsableFormFields<T>;
-    multiline?: boolean;
-    initialValue?: string;
-} & InputBaseFieldConfig) | ({
-    type: "number";
-    name: UsableFormFields<T>;
-    decimals?: number;
-    initialValue?: number;
-} & InputBaseFieldConfig) | ({
-    type: "numberRange";
-    name: UsableFormFields<T>;
-    minValue: number;
-    maxValue: number;
-    disableSlider?: boolean;
-    initialValue?: {
-        min: number;
-        max: number;
-    };
-} & InputBaseFieldConfig) | {
-    type: "boolean";
-    name: UsableFormFields<T>;
-    initialValue?: boolean;
-    checkboxLabel?: string | FormattedMessageElement;
-} | ({
-    type: "date";
-    name: UsableFormFields<T>;
-    initialValue?: string;
-} & InputBaseFieldConfig) | ({
-    type: "dateTime";
-    name: UsableFormFields<T>;
-    initialValue?: Date;
-} & InputBaseFieldConfig) | ({
-    type: "staticSelect";
-    name: UsableFormFields<T>;
-    values?: StaticSelectValue[];
-    inputType?: "select" | "radio";
-    initialValue?: string;
-} & Omit<InputBaseFieldConfig, "endAdornment">) | ({
-    type: "asyncSelect";
-    name: UsableFormFields<T>;
-    rootQuery: string;
-    labelField?: string;
-    /** Whether Autocomplete or Select should be used.
-     *
-     * defaults to true if rootQuery has a search argument
-     */
-    autocomplete?: boolean;
-    /**
-     * filter for query, passed as variable to graphql query
-     */
-    filter?: AsyncSelectFilter;
-} & Omit<InputBaseFieldConfig, "endAdornment">) | ({
-    type: "asyncSelectFilter";
-    name: string;
-    loadValueQueryField: string;
-    rootQuery: string;
-    labelField?: string;
-    /** Whether Autocomplete or Select should be used.
-     *
-     * defaults to true if rootQuery has a search argument
-     */
-    autocomplete?: boolean;
-    /**
-     * filter for query, passed as variable to graphql query
-     */
-    filter?: AsyncSelectFilter;
-} & Omit<InputBaseFieldConfig, "endAdornment">) | {
-    type: "block";
-    name: UsableFormFields<T>;
-    block: BlockInterface;
-} | ({
-    type: "fileUpload";
-    multiple?: false;
-    name: UsableFormFields<T>;
-    maxFiles?: 1;
-    download?: boolean;
-} & Pick<Partial<FinalFormFileUploadProps<false>>, "maxFileSize" | "readOnly" | "layout" | "accept">) | ({
-    type: "fileUpload";
-    multiple: true;
-    name: UsableFormFields<T>;
-    maxFiles?: number;
-    download?: boolean;
-} & Pick<Partial<FinalFormFileUploadProps<true>>, "maxFileSize" | "readOnly" | "layout" | "accept">)) & {
-    label?: string | FormattedMessageElement;
-    required?: boolean;
-    validate?: FieldValidator<unknown>;
-    helperText?: string | FormattedMessageElement;
-    readOnly?: boolean;
-};
-export declare function isFormFieldConfig<T>(arg: any): arg is FormFieldConfig<T>;
-type OptionalNestedFieldsConfig<T> = {
-    type: "optionalNestedFields";
-    name: UsableFormFields<T>;
-    checkboxLabel?: string | FormattedMessageElement;
-    fields: FormFieldConfig<any>[];
-};
-export type FormLayoutConfig<T> = {
-    type: "fieldSet";
-    name: string;
-    title?: string | FormattedMessageElement;
-    supportText?: string;
-    collapsible?: boolean;
-    initiallyExpanded?: boolean;
-    fields: (FormFieldConfig<T> | OptionalNestedFieldsConfig<T> | ComponentFormFieldConfig)[];
-} | OptionalNestedFieldsConfig<T>;
-export declare function isFormLayoutConfig<T>(arg: any): arg is FormLayoutConfig<T>;
-export type FormConfig<T extends {
-    __typename?: string;
-}> = {
-    type: "form";
-    gqlType: T["__typename"];
-    mode?: "edit" | "add" | "all";
-    fragmentName?: string;
-    createMutation?: string;
-    /**
-     * If true, scope will be passed as prop, if false scope will be fetched from ContentScopeContext
-     * @default false
-     */
-    scopeAsProp?: boolean;
-    fields: (FormFieldConfig<T> | FormLayoutConfig<T> | ComponentFormFieldConfig)[];
-    /**
-     * If true, the form will navigate to the edit page using stackSwitchApi.activatePage of the newly created item after a successful creation.
-     * @default true
-     */
-    navigateOnCreate?: boolean;
-    /**
-     * If true, the generated form will have an initialValues prop to set initial form values.
-     * @default false
-     */
-    initialValuesAsProp?: boolean;
-};
-export type InjectedFormVariables = {
-    id?: string;
-    mode?: "edit" | "add";
-    client: ApolloClient<object>;
-    formApi: FormApi<unknown, Partial<unknown>>;
-    scope: ContentScope;
-};
-export declare function injectFormVariables<T>(fn: (injectedVariables: InjectedFormVariables) => T): T;
-type BaseColumnConfig = Pick<GridColDef, "width" | "minWidth" | "maxWidth" | "flex" | "pinned" | "disableExport"> & {
-    headerName?: string | FormattedMessageElement;
-    headerInfoTooltip?: string | FormattedMessageElement;
-    visible?: ColumnVisibleOption;
-    fieldName?: string;
-};
-export type GridColumnStaticSelectLabelCellContent = {
-    primaryText?: string | FormattedMessageElement;
-    secondaryText?: string | FormattedMessageElement;
-    icon?: Icon;
-};
-export type GridColumnStaticSelectValue = StaticSelectValue | {
-    value: string | number | boolean;
-    label: string | FormattedMessageElement | GridColumnStaticSelectLabelCellContent;
-} | number | boolean;
-export type GridColumnConfig<T extends GridValidRowModel> = ({
-    type: "text";
-    renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-} | {
-    type: "number";
-    currency?: string;
-    decimals?: number;
-    renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-} | {
-    type: "boolean";
-    renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-} | {
-    type: "date";
-    renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-} | {
-    type: "dateTime";
-    renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-} | {
-    type: "staticSelect";
-    values?: GridColumnStaticSelectValue[];
-} | {
-    type: "block";
-    block: BlockInterface;
-} | {
-    type: "id";
-    renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-} | {
-    type: "manyToMany";
-    renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-    queryFields?: UsableFields<T, true>[];
-    /**
-     * The field to use as label for the default renderCell implementation.
-     */
-    labelField?: string;
-} | {
-    type: "oneToMany";
-    renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-    queryFields?: UsableFields<T, true>[];
-    /**
-     * The field to use as label for the default renderCell implementation.
-     */
-    labelField?: string;
-}) & {
-    name: UsableFields<T>;
-    filterOperators?: GridFilterOperator[];
-} & BaseColumnConfig;
-export type ActionsGridColumnConfig<T> = {
-    type: "actions";
-    queryFields?: UsableFields<T, true>[];
-    component?: ComponentType<GridCellParams>;
-} & BaseColumnConfig;
-export type VirtualGridColumnConfig<T extends GridValidRowModel> = {
-    type: "virtual";
-    name: string;
-    queryFields?: UsableFields<T, true>[];
-    renderCell: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
-} & Pick<GridColDef, "sortBy"> & BaseColumnConfig;
-type InitialFilterConfig = {
-    items: GridFilterItem[];
-    linkOperator?: "and" | "or";
-};
-type GridConfigGridColumnDef<T extends {
-    __typename?: string;
-}> = GridColumnConfig<T> | ActionsGridColumnConfig<T> | VirtualGridColumnConfig<T>;
-export type GridConfig<T extends {
-    __typename?: string;
-}> = {
-    type: "grid";
-    gqlType: T["__typename"];
-    fragmentName?: string;
-    query?: string;
-    queryParamsPrefix?: string;
-    columns: Array<GridConfigGridColumnDef<T>>;
-    excelExport?: boolean;
-    add?: boolean;
-    edit?: boolean;
-    delete?: boolean;
-    readOnly?: boolean;
-    initialSort?: Array<{
-        field: string;
-        sort: GridSortDirection;
-    }>;
-    initialFilter?: InitialFilterConfig;
-    filterProp?: boolean;
-    toolbar?: boolean;
-    toolbarActionProp?: boolean;
-    newEntryText?: string | FormattedMessageElement;
-    rowActionProp?: boolean;
-    selectionProps?: "multiSelect" | "singleSelect";
-    rowReordering?: {
-        enabled: boolean;
-        dragPreviewField?: UsableFields<T>;
-    };
-    /**
-     * If true, scope will be passed as prop, if false scope will be fetched from ContentScopeContext
-     * @default false
-     */
-    scopeAsProp?: boolean;
-    density?: "comfortable" | "compact" | "standard";
-    crudContextMenu?: {
-        deleteType?: "delete" | "remove";
-        deleteText?: string;
-    };
-};
-export type GeneratorConfig<T extends {
-    __typename?: string;
-}> = FormConfig<T> | GridConfig<T>;
-export declare function defineConfig<T extends {
-    __typename?: string;
-}>(config: GeneratorConfig<T>): GeneratorConfig<T>;
-type GQLDocumentConfig = {
-    document: string;
-    export: boolean;
-};
-export type GQLDocumentConfigMap = Record<string, GQLDocumentConfig>;
-export type GeneratorReturn = {
-    code: string;
-    gqlDocuments: GQLDocumentConfigMap;
-};
-export declare const generateCommand: Command;
-export {};

package/lib/commands/generate/generate-command.js

@@ -1,112 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateCommand = void 0;
-exports.isFormFieldConfig = isFormFieldConfig;
-exports.isFormLayoutConfig = isFormLayoutConfig;
-exports.injectFormVariables = injectFormVariables;
-exports.defineConfig = defineConfig;
-const graphql_file_loader_1 = require("@graphql-tools/graphql-file-loader");
-const load_1 = require("@graphql-tools/load");
-const child_process_1 = require("child_process");
-const commander_1 = require("commander");
-const fs_1 = require("fs");
-const glob_1 = require("glob");
-const graphql_1 = require("graphql");
-const path_1 = require("path");
-const util_1 = require("util");
-const parseConfig_1 = require("./config/parseConfig");
-const generateForm_1 = require("./generateForm/generateForm");
-const generateGrid_1 = require("./generateGrid/generateGrid");
-const writeGenerated_1 = require("./utils/writeGenerated");
-const exec = (0, util_1.promisify)(child_process_1.exec);
-function isComponentFormFieldConfig(arg) {
-    return arg && arg.type === "component";
-}
-function isFormFieldConfig(arg) {
-    return !isFormLayoutConfig(arg) && !isComponentFormFieldConfig(arg);
-}
-function isFormLayoutConfig(arg) {
-    return arg.type !== undefined && ["fieldSet", "optionalNestedFields"].includes(arg.type);
-}
-function injectFormVariables(fn) {
-    // this function is only used in config but never called at runtime
-    return fn({});
-}
-function defineConfig(config) {
-    return config;
-}
-/**
- * @experimental
- */
-function runGenerate() {
-    return __awaiter(this, arguments, void 0, function* (filePattern = "src/**/*.cometGen.{ts,tsx}") {
-        var _a;
-        const schema = yield (0, load_1.loadSchema)("./schema.gql", {
-            loaders: [new graphql_file_loader_1.GraphQLFileLoader()],
-        });
-        const gqlIntrospection = (0, graphql_1.introspectionFromSchema)(schema);
-        const writtenFiles = [];
-        const files = yield (0, glob_1.glob)(filePattern);
-        for (const file of files) {
-            let outputCode = "";
-            let gqlDocumentsOutputCode = "";
-            const targetDirectory = `${(0, path_1.dirname)(file)}/generated`;
-            const baseOutputFilename = (0, path_1.basename)(file).replace(/\.cometGen\.tsx?$/, "");
-            console.log(`generating ${file}`);
-            const config = yield (0, parseConfig_1.parseConfig)(file);
-            const codeOuputFilename = `${targetDirectory}/${(0, path_1.basename)(file.replace(/\.cometGen\.tsx?$/, ""))}.tsx`;
-            yield fs_1.promises.rm(codeOuputFilename, { force: true });
-            const exportName = (_a = file.match(/([^/]+)\.cometGen\.tsx?$/)) === null || _a === void 0 ? void 0 : _a[1];
-            if (!exportName)
-                throw new Error("Can not determine exportName");
-            let generated;
-            if (config.type == "form") {
-                generated = (0, generateForm_1.generateForm)({ exportName, gqlIntrospection, baseOutputFilename, targetDirectory }, config);
-            }
-            else if (config.type == "grid") {
-                generated = (0, generateGrid_1.generateGrid)({ exportName, gqlIntrospection, baseOutputFilename, targetDirectory }, config);
-            }
-            else {
-                throw new Error(`Unknown config type`);
-            }
-            outputCode += generated.code;
-            for (const queryName in generated.gqlDocuments) {
-                const exportStatement = generated.gqlDocuments[queryName].export ? "export " : "";
-                gqlDocumentsOutputCode += `${exportStatement} const ${queryName} = gql\`${generated.gqlDocuments[queryName].document}\`\n`;
-            }
-            yield (0, writeGenerated_1.writeGenerated)(codeOuputFilename, outputCode);
-            writtenFiles.push(codeOuputFilename);
-            if (gqlDocumentsOutputCode != "") {
-                const gqlDocumentsOuputFilename = `${targetDirectory}/${(0, path_1.basename)(file.replace(/\.cometGen\.tsx?$/, ""))}.gql.tsx`;
-                yield fs_1.promises.rm(gqlDocumentsOuputFilename, { force: true });
-                gqlDocumentsOutputCode = `import { gql } from "@apollo/client";
-                import { finalFormFileUploadFragment, finalFormFileUploadDownloadableFragment } from "@comet/cms-admin";
-
-                ${gqlDocumentsOutputCode}
-            `;
-                yield (0, writeGenerated_1.writeGenerated)(gqlDocumentsOuputFilename, gqlDocumentsOutputCode);
-                writtenFiles.push(gqlDocumentsOuputFilename);
-            }
-            console.log("");
-        }
-        if (writtenFiles.length > 0) {
-            console.log("Formatting generated files...");
-            yield exec(`./node_modules/.bin/prettier --write ${writtenFiles.join(" ")}`);
-        }
-    });
-}
-exports.generateCommand = new commander_1.Command("generate")
-    .option("-f, --file <file>", "path to config file or glob pattern to generate specific files")
-    .action((_a) => __awaiter(void 0, [_a], void 0, function* ({ file: filePattern }) {
-    console.log("️️️⚠️️️⚠️️️⚠️️️  Admin Generator is still experimental and in beta phase.  ⚠️️️⚠️️️⚠️️️\n\n");
-    yield runGenerate(filePattern);
-}));

package/lib/commands/generate/generateForm/asyncSelect/generateAsyncSelect.d.ts

@@ -1,26 +0,0 @@
-import { type IntrospectionObjectType, type IntrospectionQuery } from "graphql";
-import { type FormConfig, type FormFieldConfig } from "../../generate-command";
-import { type GenerateFieldsReturn } from "../generateFields";
-/**
- * Helper that returns the introspection object type for a given form field config, supporting the special case for asyncSelectFilter
- */
-export declare function findIntrospectionObjectType({ config, gqlIntrospection, gqlType, }: {
-    config: FormFieldConfig<any>;
-    gqlIntrospection: IntrospectionQuery;
-    gqlType: string;
-}): {
-    multiple: boolean;
-    objectType: IntrospectionObjectType;
-};
-export declare function generateAsyncSelect({ gqlIntrospection, baseOutputFilename, config, formConfig, gqlType, namePrefix, }: {
-    gqlIntrospection: IntrospectionQuery;
-    baseOutputFilename: string;
-    config: Extract<FormFieldConfig<any>, {
-        type: "asyncSelect";
-    } | {
-        type: "asyncSelectFilter";
-    }>;
-    formConfig: FormConfig<any>;
-    gqlType: string;
-    namePrefix?: string;
-}): GenerateFieldsReturn;