@compas/code-gen/src/experimental/processors/crud-information.d.ts

Generate various boring parts of your server

/**
 * Get the resolved name of the provided crud route
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @param {string} suffix
 * @returns {string}
 */
export function crudInformationGetName(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
  suffix: string,
): string;
/**
 * Get the resolved path of the provided crud route
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @param {string} suffix
 * @returns {string}
 */
export function crudInformationGetPath(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
  suffix: string,
): string;
/**
 * Get the param name for the provided crud object
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 */
export function crudInformationGetParamName(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
): string;
/**
 * Save the used model, so we don't have to resolve that each and every time.
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @param {import("../generated/common/types").ExperimentalObjectDefinition} model
 */
export function crudInformationSetModel(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
  model: import("../generated/common/types").ExperimentalObjectDefinition,
): void;
/**
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @returns {import("../generated/common/types").ExperimentalObjectDefinition}
 */
export function crudInformationGetModel(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
): import("../generated/common/types").ExperimentalObjectDefinition;
/**
 * Save the used relation and parent
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} parent
 * @param {import("../generated/common/types").
 * ExperimentalRelationDefinition} relation
 */
export function crudInformationSetRelationAndParent(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
  parent: import("../generated/common/types").ExperimentalCrudDefinition,
  relation: import("../generated/common/types").ExperimentalRelationDefinition,
): void;
/**
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @returns {import("../generated/common/types").ExperimentalRelationDefinition}
 */
export function crudInformationGetRelation(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
): import("../generated/common/types").ExperimentalRelationDefinition;
/**
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @returns {import("../generated/common/types").ExperimentalCrudDefinition}
 */
export function crudInformationGetParent(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
): import("../generated/common/types").ExperimentalCrudDefinition;
/**
 * Save the created readable type, so it is easily resolvable later on.
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @param {{ group: string, name: string }} readable
 */
export function crudInformationSetReadableType(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
  readable: {
    group: string;
    name: string;
  },
): void;
/**
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @returns {{ group: string, name: string }}
 */
export function crudInformationGetReadableType(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
): {
  group: string;
  name: string;
};
/**
 * Save the created writable type, so it is easily resolvable later on.
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @param {{ group: string, name: string }} writable
 */
export function crudInformationSetWritableType(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
  writable: {
    group: string;
    name: string;
  },
): void;
/**
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @returns {{ group: string, name: string }}
 */
export function crudInformationGetWritableType(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
): {
  group: string;
  name: string;
};
/**
 * Cache when the provided CRUD has a custom readable type.
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @param {boolean} hasCustomReadableType
 */
export function crudInformationSetHasCustomReadableType(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
  hasCustomReadableType: boolean,
): void;
/**
 * Check if the crud or parent has a custom readable type
 *
 * @param {import("../generated/common/types").ExperimentalCrudDefinition} crud
 * @returns {boolean}
 */
export function crudInformationGetHasCustomReadableType(
  crud: import("../generated/common/types").ExperimentalCrudDefinition,
): boolean;
export type CrudInformation = {
  model: import("../generated/common/types").ExperimentalObjectDefinition;
  parent?:
    | import("../generated/common/types").ExperimentalCrudDefinition
    | undefined;
  relation?:
    | import("../generated/common/types").ExperimentalRelationDefinition
    | undefined;
  readableType: {
    group: string;
    name: string;
  };
  writableType: {
    group: string;
    name: string;
  };
  hasCustomReadableType: boolean;
};
//# sourceMappingURL=crud-information.d.ts.map