foundation

App-platform foundation contracts and composition profiles for M38.

Types

AdminProvider

Admin integration provider.

pub type AdminProvider {
  EmbeddedPanel(module: String)
  ExternalBackoffice(module: String)
  MixedAdmin(primary: String, fallback: String)
}

Constructors

```
EmbeddedPanel(module: String)
```
```
ExternalBackoffice(module: String)
```

MixedAdmin(primary: String, fallback: String)

AdminSeam

Admin seam with explicit override point.

pub type AdminSeam {
  AdminSeam(
    provider: AdminProvider,
    override: OverridePoint,
    audit_sink_module: String,
    break_glass_role: String,
    approval_workflow_required: Bool,
  )
}

Constructors

AdminSeam(
  provider: AdminProvider,
  override: OverridePoint,
  audit_sink_module: String,
  break_glass_role: String,
  approval_workflow_required: Bool,
)

AppProfile

One production-shaped app-platform profile.

pub type AppProfile {
  AppProfile(
    name: String,
    auth: AuthSeam,
    admin: AdminSeam,
    policy: PolicySeam,
    billing: BillingSeam,
    surfaces: List(ProductSurface),
    workflows: List(LifecycleWorkflow),
    requires_framework_internal_patching: Bool,
  )
}

Constructors

AppProfile(
  name: String,
  auth: AuthSeam,
  admin: AdminSeam,
  policy: PolicySeam,
  billing: BillingSeam,
  surfaces: List(ProductSurface),
  workflows: List(LifecycleWorkflow),
  requires_framework_internal_patching: Bool,
)

AuthProvider

Authentication integration provider.

pub type AuthProvider {
  FirstParty(module: String)
  Oidc(module: String)
  Hybrid(primary: String, fallback: String)
}

Constructors

```
FirstParty(module: String)
```
```
Oidc(module: String)
```

Hybrid(primary: String, fallback: String)

AuthSeam

Auth seam with explicit override point.

pub type AuthSeam {
  AuthSeam(
    provider: AuthProvider,
    override: OverridePoint,
    session_ttl_minutes: Int,
    mfa_required: Bool,
    passkey_enabled: Bool,
  )
}

Constructors

AuthSeam(
  provider: AuthProvider,
  override: OverridePoint,
  session_ttl_minutes: Int,
  mfa_required: Bool,
  passkey_enabled: Bool,
)

BillingProvider

Billing integration provider.

pub type BillingProvider {
  Stripe(module: String)
  Paddle(module: String)
  MixedBilling(primary: String, fallback: String)
}

Constructors

```
Stripe(module: String)
```
```
Paddle(module: String)
```

MixedBilling(primary: String, fallback: String)

BillingSeam

Billing seam with explicit override point.

pub type BillingSeam {
  BillingSeam(
    provider: BillingProvider,
    override: OverridePoint,
    metering_source: MeteringSource,
    webhook_verification: Bool,
    dunning_enabled: Bool,
  )
}

Constructors

BillingSeam(
  provider: BillingProvider,
  override: OverridePoint,
  metering_source: MeteringSource,
  webhook_verification: Bool,
  dunning_enabled: Bool,
)

LifecycleWorkflow

Core app-platform lifecycle workflow.

pub type LifecycleWorkflow {
  AccountSignupActivation
  SubscriptionUpgrade
  AdminApprovalEscalation
  TenantPolicyReview
}

Constructors

```
AccountSignupActivation
```
```
SubscriptionUpgrade
```
```
AdminApprovalEscalation
```
```
TenantPolicyReview
```

MeteringSource

Metering projection source.

pub type MeteringSource {
  EventLog(module: String)
  UsagePipeline(module: String)
  HybridMetering(primary: String, fallback: String)
}

Constructors

```
EventLog(module: String)
```
```
UsagePipeline(module: String)
```

HybridMetering(primary: String, fallback: String)

OverridePoint

Explicit app-platform override contract.

pub type OverridePoint {
  Hook(module: String, hook: String)
  Adapter(module: String)
  RouteNamespace(module: String, namespace: String)
}

Constructors

```
Hook(module: String, hook: String)
```
```
Adapter(module: String)
```

RouteNamespace(module: String, namespace: String)

PolicyProvider

Policy integration provider.

pub type PolicyProvider {
  RoleBased(module: String)
  AttributeBased(module: String)
  MixedPolicy(primary: String, fallback: String)
}

Constructors

```
RoleBased(module: String)
```
```
AttributeBased(module: String)
```

MixedPolicy(primary: String, fallback: String)

PolicySeam

Policy seam with explicit override point.

pub type PolicySeam {
  PolicySeam(
    provider: PolicyProvider,
    override: OverridePoint,
    tenant_scoped: Bool,
    deny_by_default: Bool,
    decision_trace_enabled: Bool,
  )
}

Constructors

PolicySeam(
  provider: PolicyProvider,
  override: OverridePoint,
  tenant_scoped: Bool,
  deny_by_default: Bool,
  decision_trace_enabled: Bool,
)

ProductSurface

Product-application surface.

pub type ProductSurface {
  CustomerPortal
  AdminConsole
  PublicApi
  PartnerApi
  OperationsConsole
}

Constructors

```
CustomerPortal
```
```
AdminConsole
```
```
PublicApi
```
```
PartnerApi
```
```
OperationsConsole
```

Values

admin_provider_label

pub fn admin_provider_label(provider: AdminProvider) -> String

Admin-provider label.

auth_provider_label

pub fn auth_provider_label(provider: AuthProvider) -> String

Auth-provider label.

b2b_saas_profile

pub fn b2b_saas_profile() -> AppProfile

B2B SaaS profile.

billing_provider_label

pub fn billing_provider_label(
  provider: BillingProvider,
) -> String

Billing-provider label.

explicit_override_points

pub fn explicit_override_points(profile: AppProfile) -> Bool

All seams have explicit and external override points.

marketplace_profile

pub fn marketplace_profile() -> AppProfile

Marketplace profile with partner surface.

metering_source_label

pub fn metering_source_label(source: MeteringSource) -> String

Metering-source label.

name

pub fn name(profile: AppProfile) -> String

Profile name accessor.

operations_platform_profile

pub fn operations_platform_profile() -> AppProfile

Operations-heavy product profile.

override_point_label

pub fn override_point_label(value: OverridePoint) -> String

Override-point label.

policy_provider_label

pub fn policy_provider_label(provider: PolicyProvider) -> String

Policy-provider label.

reference_profiles

pub fn reference_profiles() -> List(AppProfile)

Reference M38 product profiles.

required_workflows

pub fn required_workflows() -> List(LifecycleWorkflow)

Required core workflows for M38 conformance.

requires_framework_internal_patching

pub fn requires_framework_internal_patching(
  profile: AppProfile,
) -> Bool

Whether profile requires framework-internal patching.

seam_contract_signature

pub fn seam_contract_signature(profile: AppProfile) -> String

Stable integration-seam signature for extension contracts.

signature

pub fn signature(profile: AppProfile) -> String

Stable profile signature.

supports_workflow

pub fn supports_workflow(
  profile: AppProfile,
  workflow: LifecycleWorkflow,
) -> Bool

Check whether one workflow is supported by one profile.

surface_label

pub fn surface_label(surface: ProductSurface) -> String

Product-surface label.

surfaces

pub fn surfaces(profile: AppProfile) -> List(ProductSurface)

Profile surfaces accessor.

valid

pub fn valid(profile: AppProfile) -> Bool

Validate one app-platform profile.

workflow_label

pub fn workflow_label(workflow: LifecycleWorkflow) -> String

Workflow label.

workflow_matrix_signature

pub fn workflow_matrix_signature(profile: AppProfile) -> String

Stable workflow matrix signature.

workflow_runs_without_internal_patching

pub fn workflow_runs_without_internal_patching(
  profile: AppProfile,
  workflow: LifecycleWorkflow,
) -> Bool

Verify one workflow can run through explicit seams without framework patching.

workflows

pub fn workflows(profile: AppProfile) -> List(LifecycleWorkflow)

Profile workflows accessor.