oc · docs
docs / documentation

@orangecheck/me-client


@orangecheck/me-client / config

Variable: config

const config: {
  archetypes: readonly ArchetypeTemplate[];
  fromTemplate: (useCase: IntegratorArchetype, identity: ProjectIdentity) => IntegratorPriceConfig;
  getArchetype: (id: IntegratorArchetype) => ArchetypeTemplate;
  validate: (cfg: IntegratorPriceConfig) => ValidationResult;
};

Defined in: me-client/src/config.ts:49

Type Declaration

NameTypeDefault valueDescriptionDefined in
<a id="property-archetypes"></a> archetypesreadonly ArchetypeTemplate[]ARCHETYPE_TEMPLATESAll available archetypes · render in a picker.me-client/src/config.ts:56
<a id="property-fromtemplate"></a> fromTemplate()(useCase: IntegratorArchetype, identity: ProjectIdentity) => IntegratorPriceConfig-Build a complete IntegratorPriceConfig from an archetype id + the project's identity fields. Every subtype gets an entry — the archetype's listed subtypes get the template's pricing; everything else gets enabled: false with conservative defaults so the config is type-complete and the integrator can flip-on later subtypes without re-deriving prices. Throws synchronously if useCase isn't a known archetype id.me-client/src/config.ts:51
<a id="property-getarchetype"></a> getArchetype()(id: IntegratorArchetype) => ArchetypeTemplategetArchetypeTemplateLook up a template's metadata · for rendering "you picked X" state and offering one-click swaps in your own UI. Look up a template's metadata · used by config-editor UIs to render "you're on the X template · here's what it enables" copy.me-client/src/config.ts:54
<a id="property-validate"></a> validate()(cfg: IntegratorPriceConfig) => ValidationResult--me-client/src/config.ts:50