Skip to content
SAPA

Sapa

Provides the closed Sapa facade from storage, provider registry, and clock layers.

Declaration

Section titled “Declaration”
const Sapa: {
  layer: Layer.Layer<SapaService, never,
     | AccessContributionStore
     | CatalogStore
     | CheckoutProviderRegistry
     | CheckoutStore
     | Clock
     | CreditLotStore
     | CustomerStore
     | FulfillmentObligationStore
     | IdGenerator
     | LicenseCredentialStore
     | MeteredInvoiceStore
     | MeteredUsageStore
     | OfferDefinitionStore
     | PaymentRefundStore
     | PaymentSettlementStore
     | SapaInstallation
     | SeatAssignmentStore
     | SeatCapacityStore
     | SnapshotProtection
    | SubscriptionHistoryStore>;
  makeConfigured: typeof makeConfiguredSapaLayer;
  make: (capabilityManifestLayer, merchantAccessPolicyLayer?) => Layer.Layer<SapaService, never,
     | AccessContributionStore
     | CatalogStore
     | CheckoutProviderRegistry
     | CheckoutStore
     | Clock
     | CreditLotStore
     | CustomerStore
     | FulfillmentObligationStore
     | IdGenerator
     | LicenseCredentialStore
     | MeteredInvoiceStore
     | MeteredUsageStore
     | OfferDefinitionStore
     | PaymentRefundStore
     | PaymentSettlementStore
     | SapaInstallation
     | SeatAssignmentStore
     | SeatCapacityStore
     | SnapshotProtection
    | SubscriptionHistoryStore>;
  makeWithDownloads: (capabilityManifestLayer, downloadAssetLayer, downloadPolicy, merchantAccessPolicyLayer?) => Layer.Layer<SapaService, never,
     | AccessContributionStore
     | CatalogStore
     | CheckoutProviderRegistry
     | CheckoutStore
     | Clock
     | CreditLotStore
     | CustomerStore
     | FulfillmentObligationStore
     | IdGenerator
     | LicenseCredentialStore
     | MeteredInvoiceStore
     | MeteredUsageStore
     | OfferDefinitionStore
     | PaymentRefundStore
     | PaymentSettlementStore
     | SapaInstallation
     | SeatAssignmentStore
     | SeatCapacityStore
     | SnapshotProtection
    | SubscriptionHistoryStore>;
  makeWithLicensing: (capabilityManifestLayer, cryptoLayer, licensePolicy, merchantAccessPolicyLayer?) => Layer.Layer<SapaService, never,
     | AccessContributionStore
     | CatalogStore
     | CheckoutProviderRegistry
     | CheckoutStore
     | Clock
     | CreditLotStore
     | CustomerStore
     | FulfillmentObligationStore
     | IdGenerator
     | LicenseCredentialStore
     | MeteredInvoiceStore
     | MeteredUsageStore
     | OfferDefinitionStore
     | PaymentRefundStore
     | PaymentSettlementStore
     | SapaInstallation
     | SeatAssignmentStore
     | SeatCapacityStore
     | SnapshotProtection
    | SubscriptionHistoryStore>;
};

Type Declaration

Section titled “Type Declaration”

layer

Section titled “layer”
layer: Layer.Layer<SapaService, never,
  | AccessContributionStore
  | CatalogStore
  | CheckoutProviderRegistry
  | CheckoutStore
  | Clock
  | CreditLotStore
  | CustomerStore
  | FulfillmentObligationStore
  | IdGenerator
  | LicenseCredentialStore
  | MeteredInvoiceStore
  | MeteredUsageStore
  | OfferDefinitionStore
  | PaymentRefundStore
  | PaymentSettlementStore
  | SapaInstallation
  | SeatAssignmentStore
  | SeatCapacityStore
  | SnapshotProtection
| SubscriptionHistoryStore>;

makeConfigured

Section titled “makeConfigured”
makeConfigured: typeof makeConfiguredSapaLayer;

Builds the facade from exact request-scoped capability composition.

make

Section titled “make”
make: (capabilityManifestLayer, merchantAccessPolicyLayer?) => Layer.Layer<SapaService, never,
  | AccessContributionStore
  | CatalogStore
  | CheckoutProviderRegistry
  | CheckoutStore
  | Clock
  | CreditLotStore
  | CustomerStore
  | FulfillmentObligationStore
  | IdGenerator
  | LicenseCredentialStore
  | MeteredInvoiceStore
  | MeteredUsageStore
  | OfferDefinitionStore
  | PaymentRefundStore
  | PaymentSettlementStore
  | SapaInstallation
  | SeatAssignmentStore
  | SeatCapacityStore
  | SnapshotProtection
| SubscriptionHistoryStore>;

Builds the facade from a trusted manifest Layer derived from composed capabilities.

Parameters

Section titled “Parameters”
capabilityManifestLayer
Section titled “capabilityManifestLayer”

Layer.Layer<OfferCapabilityManifest>

merchantAccessPolicyLayer?
Section titled “merchantAccessPolicyLayer?”

Layer.Layer<MerchantAccessPolicyRegistry>

Returns

Section titled “Returns”

Layer.Layer<SapaService, never, | AccessContributionStore | CatalogStore | CheckoutProviderRegistry | CheckoutStore | Clock | CreditLotStore | CustomerStore | FulfillmentObligationStore | IdGenerator | LicenseCredentialStore | MeteredInvoiceStore | MeteredUsageStore | OfferDefinitionStore | PaymentRefundStore | PaymentSettlementStore | SapaInstallation | SeatAssignmentStore | SeatCapacityStore | SnapshotProtection | SubscriptionHistoryStore>

makeWithDownloads

Section titled “makeWithDownloads”
makeWithDownloads: (capabilityManifestLayer, downloadAssetLayer, downloadPolicy, merchantAccessPolicyLayer?) => Layer.Layer<SapaService, never,
  | AccessContributionStore
  | CatalogStore
  | CheckoutProviderRegistry
  | CheckoutStore
  | Clock
  | CreditLotStore
  | CustomerStore
  | FulfillmentObligationStore
  | IdGenerator
  | LicenseCredentialStore
  | MeteredInvoiceStore
  | MeteredUsageStore
  | OfferDefinitionStore
  | PaymentRefundStore
  | PaymentSettlementStore
  | SapaInstallation
  | SeatAssignmentStore
  | SeatCapacityStore
  | SnapshotProtection
| SubscriptionHistoryStore>;

Builds the facade with exact request-scoped download asset implementations.

Parameters

Section titled “Parameters”
capabilityManifestLayer
Section titled “capabilityManifestLayer”

Layer.Layer<OfferCapabilityManifest>

downloadAssetLayer
Section titled “downloadAssetLayer”

Layer.Layer<DownloadAssetRegistry>

downloadPolicy
Section titled “downloadPolicy”

DownloadAuthorizationPolicy

merchantAccessPolicyLayer?
Section titled “merchantAccessPolicyLayer?”

Layer.Layer<MerchantAccessPolicyRegistry>

Returns

Section titled “Returns”

Layer.Layer<SapaService, never, | AccessContributionStore | CatalogStore | CheckoutProviderRegistry | CheckoutStore | Clock | CreditLotStore | CustomerStore | FulfillmentObligationStore | IdGenerator | LicenseCredentialStore | MeteredInvoiceStore | MeteredUsageStore | OfferDefinitionStore | PaymentRefundStore | PaymentSettlementStore | SapaInstallation | SeatAssignmentStore | SeatCapacityStore | SnapshotProtection | SubscriptionHistoryStore>

makeWithLicensing

Section titled “makeWithLicensing”
makeWithLicensing: (capabilityManifestLayer, cryptoLayer, licensePolicy, merchantAccessPolicyLayer?) => Layer.Layer<SapaService, never,
  | AccessContributionStore
  | CatalogStore
  | CheckoutProviderRegistry
  | CheckoutStore
  | Clock
  | CreditLotStore
  | CustomerStore
  | FulfillmentObligationStore
  | IdGenerator
  | LicenseCredentialStore
  | MeteredInvoiceStore
  | MeteredUsageStore
  | OfferDefinitionStore
  | PaymentRefundStore
  | PaymentSettlementStore
  | SapaInstallation
  | SeatAssignmentStore
  | SeatCapacityStore
  | SnapshotProtection
| SubscriptionHistoryStore>;

Builds the facade with request-scoped cryptographic license operations.

Parameters

Section titled “Parameters”
capabilityManifestLayer
Section titled “capabilityManifestLayer”

Layer.Layer<OfferCapabilityManifest>

cryptoLayer
Section titled “cryptoLayer”

Layer.Layer<Crypto>

licensePolicy
Section titled “licensePolicy”

LicenseIssuancePolicy

merchantAccessPolicyLayer?
Section titled “merchantAccessPolicyLayer?”

Layer.Layer<MerchantAccessPolicyRegistry>

Returns

Section titled “Returns”

Layer.Layer<SapaService, never, | AccessContributionStore | CatalogStore | CheckoutProviderRegistry | CheckoutStore | Clock | CreditLotStore | CustomerStore | FulfillmentObligationStore | IdGenerator | LicenseCredentialStore | MeteredInvoiceStore | MeteredUsageStore | OfferDefinitionStore | PaymentRefundStore | PaymentSettlementStore | SapaInstallation | SeatAssignmentStore | SeatCapacityStore | SnapshotProtection | SubscriptionHistoryStore>