@o3r/schematics
Version:
Schematics module of the Otter framework
38 lines • 1.61 kB
TypeScript
import type { PackageJson } from 'type-fest';
/** Package as return by the NPM Registry */
export type NpmRegistryPackage = Pick<PackageJson, 'name' | 'description' | 'version' | 'keywords'> & {
/** Package name */
name: string;
/** Scope of the package */
scope?: string;
/** Links provided for the package */
links?: {
npm: string;
homepage?: string;
repository?: string;
bugs?: string;
};
/** package.json information */
package?: PackageJson;
};
/** Message Return by the NPM Registry Search commend */
export type NPMRegistrySearchResponse = {
objects: {
package?: NpmRegistryPackage;
}[];
};
/** Prefix of the Otter module keyword tags */
export declare const OTTER_MODULE_PREFIX = "otter-";
/** Otter NPM Keyword pattern */
export type OtterModuleTag<T extends string = ''> = `${typeof OTTER_MODULE_PREFIX}${T}`;
/** Prefix of the Otter module keyword tags */
export declare const OTTER_MODULE_PRESET_PREFIX: OtterModuleTag<'preset-'>;
/** Otter Preset NPM Keyword pattern */
export type OtterModulePreset<T extends string = ''> = `${typeof OTTER_MODULE_PRESET_PREFIX}${T}`;
/** Keyword defining an Otter compatible module */
export declare const OTTER_MODULE_KEYWORD: OtterModuleTag<'module'>;
/** Package Keyword to identify the module allowing CMS administration */
export declare const OTTER_KEYWORD_CMS: OtterModuleTag<'cms'>;
/** List of whitelisted package scopes for Otter modules */
export declare const OTTER_MODULE_SUPPORTED_SCOPES: readonly ["otter", "o3r"];
//# sourceMappingURL=modules-constants.d.ts.map