@eide/foir-cli 0.18.0 → 0.19.0

package/dist/lib/config-helpers.d.ts

@@ -16,28 +16,57 @@
  * });
  * ```
  */
-interface SelectFieldConfig extends Record<string, unknown> {
+/**
+ * `select` is record-backed: options come from records of `optionModelKey`.
+ * For inline `{label, value}` choices, declare `type: 'enum'` instead — the
+ * `options?: never` here forbids the legacy shape at the type level.
+ */
+interface SelectFieldConfig {
     optionModelKey: string;
     multiple?: boolean;
+    options?: never;
+}
+interface EnumFieldOption {
+    label: string;
+    value: string;
+}
+/**
+ * `enum` is config-only: the storefront receives a typed string-literal
+ * union from inline `{label, value}` options. Variant overrides apply;
+ * locale overrides do not.
+ */
+interface EnumFieldConfig {
+    options: EnumFieldOption[];
+    multiple?: boolean;
+    default?: string | string[];
 }
-type FieldDefinitionInput = {
+interface BaseFieldDefinitionInput {
     key: string;
-    type: string;
     label?: string;
     required?: boolean;
     helpText?: string;
     placeholder?: string;
     defaultValue?: unknown;
-    config?: Record<string, unknown>;
     itemType?: string;
     storage?: string;
     templateZone?: string;
     zoneOrder?: number;
-};
-type SelectFieldDefinitionInput = Omit<FieldDefinitionInput, 'type' | 'config'> & {
+}
+type SelectFieldDefinitionInput = BaseFieldDefinitionInput & {
     type: 'select';
     config: SelectFieldConfig;
 };
+type EnumFieldDefinitionInput = BaseFieldDefinitionInput & {
+    type: 'enum';
+    config: EnumFieldConfig;
+};
+type GenericFieldDefinitionInput = BaseFieldDefinitionInput & {
+    type: string;
+    config?: Record<string, unknown> & {
+        options?: never;
+    };
+};
+type FieldDefinitionInput = SelectFieldDefinitionInput | EnumFieldDefinitionInput | GenericFieldDefinitionInput;
 interface ApplyConfigModelInput {
     key: string;
     name: string;
@@ -342,6 +371,8 @@ declare function defineModel(model: ApplyConfigModelInput): ApplyConfigModelInpu
 declare function defineField(field: FieldDefinitionInput): FieldDefinitionInput;
 /** Define a select field — requires `optionModelKey` pointing to a model whose records become options. */
 declare function defineSelectField(field: SelectFieldDefinitionInput): FieldDefinitionInput;
+/** Define an enum field — config-only choice from inline `{label, value}` options. */
+declare function defineEnumField(field: EnumFieldDefinitionInput): FieldDefinitionInput;
 /** Define an operation with type safety. */
 declare function defineOperation(operation: ApplyConfigOperationInput): ApplyConfigOperationInput;
 /** Define a segment with type safety. */
@@ -388,4 +419,4 @@ interface FoirSecretsConfig {
  */
 declare function defineSecrets(config: FoirSecretsConfig): FoirSecretsConfig;
 
-export { type AppInput, type AppPlacementFieldChoiceInput, type AppSinkMappingInput, type AppSourceMappingInput, type ApplyConfigApiKeyInput, type ApplyConfigAuthProviderInput, type ApplyConfigHookInput, type ApplyConfigInput, type ApplyConfigModelInput, type ApplyConfigOperationInput, type ApplyConfigPlacementInput, type ApplyConfigProjectInput, type ApplyConfigProjectSettingsInput, type ApplyConfigScheduleInput, type ApplyConfigSegmentInput, type ExpressionPrecondition, type FieldDefinitionInput, type FoirSecretsConfig, type Precondition, type QuotaRule, type SecretDeclaration, type SecretOwnerKind, type SegmentPrecondition, type SelectFieldConfig, type SelectFieldDefinitionInput, defineAuthProvider, defineConfig, defineField, defineHook, defineModel, defineOperation, definePlacement, defineSchedule, defineSecrets, defineSegment, defineSelectField };
+export { type AppInput, type AppPlacementFieldChoiceInput, type AppSinkMappingInput, type AppSourceMappingInput, type ApplyConfigApiKeyInput, type ApplyConfigAuthProviderInput, type ApplyConfigHookInput, type ApplyConfigInput, type ApplyConfigModelInput, type ApplyConfigOperationInput, type ApplyConfigPlacementInput, type ApplyConfigProjectInput, type ApplyConfigProjectSettingsInput, type ApplyConfigScheduleInput, type ApplyConfigSegmentInput, type EnumFieldConfig, type EnumFieldDefinitionInput, type EnumFieldOption, type ExpressionPrecondition, type FieldDefinitionInput, type FoirSecretsConfig, type Precondition, type QuotaRule, type SecretDeclaration, type SecretOwnerKind, type SegmentPrecondition, type SelectFieldConfig, type SelectFieldDefinitionInput, defineAuthProvider, defineConfig, defineEnumField, defineField, defineHook, defineModel, defineOperation, definePlacement, defineSchedule, defineSecrets, defineSegment, defineSelectField };

package/dist/lib/config-helpers.js

@@ -11,6 +11,9 @@ function defineField(field) {
 function defineSelectField(field) {
   return field;
 }
+function defineEnumField(field) {
+  return field;
+}
 function defineOperation(operation) {
   return operation;
 }
@@ -35,6 +38,7 @@ function defineSecrets(config) {
 export {
   defineAuthProvider,
   defineConfig,
+  defineEnumField,
   defineField,
   defineHook,
   defineModel,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eide/foir-cli",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Universal platform CLI for Foir platform",
   "type": "module",
   "publishConfig": {