@contractspec/example.integration-stripe 3.7.6 → 3.7.7

package/.turbo/turbo-build.log

@@ -3,7 +3,7 @@ $ bun run prebuild && bun run build:bundle && bun run build:types
 $ contractspec-bun-build prebuild
 $ contractspec-bun-build transpile
 [contractspec-bun-build] transpile target=bun root=src entries=9 noBundle=false
-Bundled 9 modules in 32ms
+Bundled 9 modules in 13ms
 
   ./blueprint.js                        1.77 KB  (entry point)
   ./index.js                            8.59 KB  (entry point)
@@ -16,7 +16,7 @@ Bundled 9 modules in 32ms
   ./tenant.js                           1.34 KB  (entry point)
 
 [contractspec-bun-build] transpile target=node root=src entries=9 noBundle=false
-Bundled 9 modules in 18ms
+Bundled 9 modules in 24ms
 
   ./blueprint.js                        1.77 KB  (entry point)
   ./index.js                            8.57 KB  (entry point)
@@ -29,7 +29,7 @@ Bundled 9 modules in 18ms
   ./tenant.js                           1.33 KB  (entry point)
 
 [contractspec-bun-build] transpile target=browser root=src entries=9 noBundle=false
-Bundled 9 modules in 38ms
+Bundled 9 modules in 24ms
 
   ./blueprint.js                        1.77 KB  (entry point)
   ./index.js                            8.57 KB  (entry point)

package/AGENTS.md

@@ -1,34 +1,57 @@
-# AI Agent Guide -- `@contractspec/example.integration-stripe`
+# AI Agent Guide — `@contractspec/example.integration-stripe`
 
 Scope: `packages/examples/integration-stripe/*`
 
-Demonstrates Stripe Payments integration with blueprint, workflow, and tenant configuration patterns.
+Integration example – Stripe Payments (blueprint + workflow + tenant config).
 
 ## Quick Context
 
-- **Layer**: example
-- **Related Packages**: `lib.schema`, `lib.contracts-spec`, `lib.contracts-integrations`
+- Layer: `example`.
+- Package visibility: published package.
+- Primary consumers are example explorers, template authors, and documentation readers.
+- Related packages: `@contractspec/lib.contracts-integrations`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
 
-## What This Demonstrates
+## Architecture
 
-- Integration blueprint definition for Stripe
-- Payment workflow with typed steps
-- Multi-tenant configuration pattern
-- Connection sample for credential wiring
+- `src/blueprint.ts` is part of the package's public or composition surface.
+- `src/connection.sample.ts` is part of the package's public or composition surface.
+- `src/docs/` contains docblocks and documentation-facing exports.
+- `src/example.ts` is the runnable example entrypoint.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/integration-stripe.feature.ts` defines a feature entrypoint.
+- `src/tenant.ts` is part of the package's public or composition surface.
 
-## Public Exports
+## Public Surface
 
-- `.` -- root barrel
-- `./blueprint` -- Stripe integration blueprint
-- `./connection.sample` -- sample connection config
-- `./docs` -- DocBlock documentation
-- `./example` -- runnable example entry point
-- `./tenant` -- tenant configuration
-- `./workflow` -- payment workflow definition
+- Export `.` resolves through `./src/index.ts`.
+- Export `./blueprint` resolves through `./src/blueprint.ts`.
+- Export `./connection.sample` resolves through `./src/connection.sample.ts`.
+- Export `./docs` resolves through `./src/docs/index.ts`.
+- Export `./docs/integration-stripe.docblock` resolves through `./src/docs/integration-stripe.docblock.ts`.
+- Export `./example` resolves through `./src/example.ts`.
+- Export `./integration-stripe.feature` resolves through `./src/integration-stripe.feature.ts`.
+- Export `./tenant` resolves through `./src/tenant.ts`.
+- Export `./workflow` resolves through `./src/workflow.ts`.
+
+## Guardrails
+
+- Keep the example package demonstrative, buildable, and aligned with the exported feature surface.
+- Do not add hidden production assumptions that are not actually implemented in the example.
+- Changes here can affect downstream packages such as `@contractspec/lib.contracts-integrations`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+- Changes here can affect downstream packages such as `@contractspec/lib.contracts-integrations`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
 
 ## Local Commands
 
-- Build: `bun run build`
-- Dev: `bun run dev`
-- Test: `bun test`
-- Typecheck: `bun run typecheck`
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run test` — bun test --pass-with-no-tests
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild

package/README.md

@@ -1,29 +1,73 @@
-### Integration Example – Stripe Payments
+# @contractspec/example.integration-stripe
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
+**Integration example – Stripe Payments (blueprint + workflow + tenant config).**
 
-This example shows how to wire the `IntegrationSpec`/`TenantAppConfig` layers together to enable Stripe-backed payments for ArtisanOS.
+## What This Demonstrates
 
-Files included:
+- Integration blueprint definition for Stripe.
+- Payment workflow with typed steps.
+- Multi-tenant configuration pattern.
+- Connection sample for credential wiring.
+- `src/docs/` contains docblocks and documentation-facing exports.
+- `src/docs/` contains docblocks and documentation-facing exports.
 
-- `blueprint.ts` – declares the `AppBlueprintSpec` enabling the `payments.psp` capability and mapping the payment workflow.
-- `workflow.ts` – minimal `WorkflowSpec` that invokes Stripe operations (`payments.stripe.chargeCard`).
-- `tenant.ts` – tenant configuration binding the workflow to a concrete Stripe `IntegrationConnection`.
-- `connection.sample.ts` – sample connection payload illustrating the data saved by the integrations service.
-- `translation.catalog.json` *(optional)* – canonical strings referenced by `branding.appNameKey`.
+## Running Locally
 
-When the workflow runner executes the `charge` step, the `WorkflowRunner` now surfaces the tenant `ResolvedAppConfig` (including integrations, branding, and translations) through `OperationExecutorContext.resolvedAppConfig`. An implementation of `opExecutor` can:
+From `packages/examples/integration-stripe`:
+- `bun run dev`
+- `bun run build`
+- `bun run test`
+- `bun run typecheck`
 
-- Pull the connection via `context.integrations[0]` and ask a `secretProvider` for Stripe keys.
-- Resolve tenant-specific branding via `context.branding` for emails or receipts.
-- Resolve localized copy using `context.translationResolver` (if provided by the host).
+## Usage
 
-Recommended next steps:
+Use `@contractspec/example.integration-stripe` as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
 
-1. Persist the sample connection through the integration CRUD contracts (`integrations.connection.create`).
-2. Register the blueprint + workflow + translation catalog in your registry.
-3. Use `registerIntegrationContracts` and `registerAppConfigContracts` to expose the connection, branding, and translation management operations.
-4. Implement the payment contract handlers to read `ctx.integrations`, fetch secrets through `ctx.secretProvider`, and execute Stripe calls.
-5. Render receipts or notifications by combining `ctx.branding` (logos/domain) and `ctx.translation.resolve(key, locale)` for localized copy.
+## Architecture
 
+- `src/blueprint.ts` is part of the package's public or composition surface.
+- `src/connection.sample.ts` is part of the package's public or composition surface.
+- `src/docs/` contains docblocks and documentation-facing exports.
+- `src/example.ts` is the runnable example entrypoint.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/integration-stripe.feature.ts` defines a feature entrypoint.
+- `src/tenant.ts` is part of the package's public or composition surface.
+
+## Public Entry Points
+
+- Export `.` resolves through `./src/index.ts`.
+- Export `./blueprint` resolves through `./src/blueprint.ts`.
+- Export `./connection.sample` resolves through `./src/connection.sample.ts`.
+- Export `./docs` resolves through `./src/docs/index.ts`.
+- Export `./docs/integration-stripe.docblock` resolves through `./src/docs/integration-stripe.docblock.ts`.
+- Export `./example` resolves through `./src/example.ts`.
+- Export `./integration-stripe.feature` resolves through `./src/integration-stripe.feature.ts`.
+- Export `./tenant` resolves through `./src/tenant.ts`.
+- Export `./workflow` resolves through `./src/workflow.ts`.
+
+## Local Commands
+
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run test` — bun test --pass-with-no-tests
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild
+
+## Recent Updates
+
+- Replace eslint+prettier by biomejs to optimize speed.
+- Missing contract layers.
+
+## Notes
+
+- Works alongside `@contractspec/lib.contracts-integrations`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.

package/dist/browser/index.js

@@ -148,57 +148,29 @@ var example = defineExample({
 });
 var example_default = example;
 
-// src/workflow.ts
-import {
-  OwnersEnum as OwnersEnum2,
-  StabilityEnum as StabilityEnum2,
-  TagsEnum as TagsEnum2
-} from "@contractspec/lib.contracts-spec/ownership";
-var collectPaymentWorkflow = {
+// src/integration-stripe.feature.ts
+import { defineFeature } from "@contractspec/lib.contracts-spec";
+var IntegrationStripeFeature = defineFeature({
   meta: {
-    key: "artisan.payments.collectPayment",
+    key: "integration-stripe",
     version: "1.0.0",
-    title: "Collect Card Payment",
-    description: "Charge a customer using the tenant Stripe connection and record settlement details.",
-    domain: "payments",
-    owners: [OwnersEnum2.PlatformCore],
-    tags: [TagsEnum2.Marketplace, "stripe"],
-    stability: StabilityEnum2.Experimental
+    title: "Stripe Payments Integration",
+    description: "Stripe payments integration with blueprint, workflow, and tenant configuration",
+    domain: "integration",
+    owners: ["@integration-team"],
+    tags: ["integration", "stripe", "payments"],
+    stability: "experimental"
   },
-  definition: {
-    entryStepId: "prepare",
-    steps: [
-      {
-        id: "prepare",
-        type: "automation",
-        label: "Prepare charge parameters",
-        action: {
-          operation: { key: "payments.prepareCharge", version: "1.0.0" }
-        }
-      },
-      {
-        id: "charge",
-        type: "automation",
-        label: "Charge card via Stripe",
-        action: {
-          operation: { key: "payments.stripe.chargeCard", version: "1.0.0" }
-        }
-      },
-      {
-        id: "confirm",
-        type: "automation",
-        label: "Confirm settlement",
-        action: {
-          operation: { key: "payments.recordSettlement", version: "1.0.0" }
-        }
-      }
-    ],
-    transitions: [
-      { from: "prepare", to: "charge" },
-      { from: "charge", to: "confirm", condition: "output.success === true" }
-    ]
-  }
-};
+  integrations: [
+    { key: "integration-stripe.integration.psp", version: "1.0.0" }
+  ],
+  workflows: [{ key: "integration-stripe.workflow.payment", version: "1.0.0" }],
+  policies: [{ key: "integration-stripe.policy.payments", version: "1.0.0" }],
+  docs: [
+    "docs.examples.integration-stripe",
+    "docs.examples.integration-stripe.usage"
+  ]
+});
 
 // src/tenant.ts
 var artisanStripeTenantConfig = {
@@ -253,29 +225,57 @@ var artisanStripeTenantConfig = {
   notes: "Stripe connection bound for production payments."
 };
 
-// src/integration-stripe.feature.ts
-import { defineFeature } from "@contractspec/lib.contracts-spec";
-var IntegrationStripeFeature = defineFeature({
+// src/workflow.ts
+import {
+  OwnersEnum as OwnersEnum2,
+  StabilityEnum as StabilityEnum2,
+  TagsEnum as TagsEnum2
+} from "@contractspec/lib.contracts-spec/ownership";
+var collectPaymentWorkflow = {
   meta: {
-    key: "integration-stripe",
+    key: "artisan.payments.collectPayment",
     version: "1.0.0",
-    title: "Stripe Payments Integration",
-    description: "Stripe payments integration with blueprint, workflow, and tenant configuration",
-    domain: "integration",
-    owners: ["@integration-team"],
-    tags: ["integration", "stripe", "payments"],
-    stability: "experimental"
+    title: "Collect Card Payment",
+    description: "Charge a customer using the tenant Stripe connection and record settlement details.",
+    domain: "payments",
+    owners: [OwnersEnum2.PlatformCore],
+    tags: [TagsEnum2.Marketplace, "stripe"],
+    stability: StabilityEnum2.Experimental
   },
-  integrations: [
-    { key: "integration-stripe.integration.psp", version: "1.0.0" }
-  ],
-  workflows: [{ key: "integration-stripe.workflow.payment", version: "1.0.0" }],
-  policies: [{ key: "integration-stripe.policy.payments", version: "1.0.0" }],
-  docs: [
-    "docs.examples.integration-stripe",
-    "docs.examples.integration-stripe.usage"
-  ]
-});
+  definition: {
+    entryStepId: "prepare",
+    steps: [
+      {
+        id: "prepare",
+        type: "automation",
+        label: "Prepare charge parameters",
+        action: {
+          operation: { key: "payments.prepareCharge", version: "1.0.0" }
+        }
+      },
+      {
+        id: "charge",
+        type: "automation",
+        label: "Charge card via Stripe",
+        action: {
+          operation: { key: "payments.stripe.chargeCard", version: "1.0.0" }
+        }
+      },
+      {
+        id: "confirm",
+        type: "automation",
+        label: "Confirm settlement",
+        action: {
+          operation: { key: "payments.recordSettlement", version: "1.0.0" }
+        }
+      }
+    ],
+    transitions: [
+      { from: "prepare", to: "charge" },
+      { from: "charge", to: "confirm", condition: "output.success === true" }
+    ]
+  }
+};
 export {
   stripeLiveConnection,
   example_default as example,

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export * from './blueprint';
-export * from './workflow';
-export * from './tenant';
 export * from './connection.sample';
-export * from './integration-stripe.feature';
 export { default as example } from './example';
+export * from './integration-stripe.feature';
+export * from './tenant';
+export * from './workflow';
 import './docs';

package/dist/index.js

@@ -149,57 +149,29 @@ var example = defineExample({
 });
 var example_default = example;
 
-// src/workflow.ts
-import {
-  OwnersEnum as OwnersEnum2,
-  StabilityEnum as StabilityEnum2,
-  TagsEnum as TagsEnum2
-} from "@contractspec/lib.contracts-spec/ownership";
-var collectPaymentWorkflow = {
+// src/integration-stripe.feature.ts
+import { defineFeature } from "@contractspec/lib.contracts-spec";
+var IntegrationStripeFeature = defineFeature({
   meta: {
-    key: "artisan.payments.collectPayment",
+    key: "integration-stripe",
     version: "1.0.0",
-    title: "Collect Card Payment",
-    description: "Charge a customer using the tenant Stripe connection and record settlement details.",
-    domain: "payments",
-    owners: [OwnersEnum2.PlatformCore],
-    tags: [TagsEnum2.Marketplace, "stripe"],
-    stability: StabilityEnum2.Experimental
+    title: "Stripe Payments Integration",
+    description: "Stripe payments integration with blueprint, workflow, and tenant configuration",
+    domain: "integration",
+    owners: ["@integration-team"],
+    tags: ["integration", "stripe", "payments"],
+    stability: "experimental"
   },
-  definition: {
-    entryStepId: "prepare",
-    steps: [
-      {
-        id: "prepare",
-        type: "automation",
-        label: "Prepare charge parameters",
-        action: {
-          operation: { key: "payments.prepareCharge", version: "1.0.0" }
-        }
-      },
-      {
-        id: "charge",
-        type: "automation",
-        label: "Charge card via Stripe",
-        action: {
-          operation: { key: "payments.stripe.chargeCard", version: "1.0.0" }
-        }
-      },
-      {
-        id: "confirm",
-        type: "automation",
-        label: "Confirm settlement",
-        action: {
-          operation: { key: "payments.recordSettlement", version: "1.0.0" }
-        }
-      }
-    ],
-    transitions: [
-      { from: "prepare", to: "charge" },
-      { from: "charge", to: "confirm", condition: "output.success === true" }
-    ]
-  }
-};
+  integrations: [
+    { key: "integration-stripe.integration.psp", version: "1.0.0" }
+  ],
+  workflows: [{ key: "integration-stripe.workflow.payment", version: "1.0.0" }],
+  policies: [{ key: "integration-stripe.policy.payments", version: "1.0.0" }],
+  docs: [
+    "docs.examples.integration-stripe",
+    "docs.examples.integration-stripe.usage"
+  ]
+});
 
 // src/tenant.ts
 var artisanStripeTenantConfig = {
@@ -254,29 +226,57 @@ var artisanStripeTenantConfig = {
   notes: "Stripe connection bound for production payments."
 };
 
-// src/integration-stripe.feature.ts
-import { defineFeature } from "@contractspec/lib.contracts-spec";
-var IntegrationStripeFeature = defineFeature({
+// src/workflow.ts
+import {
+  OwnersEnum as OwnersEnum2,
+  StabilityEnum as StabilityEnum2,
+  TagsEnum as TagsEnum2
+} from "@contractspec/lib.contracts-spec/ownership";
+var collectPaymentWorkflow = {
   meta: {
-    key: "integration-stripe",
+    key: "artisan.payments.collectPayment",
     version: "1.0.0",
-    title: "Stripe Payments Integration",
-    description: "Stripe payments integration with blueprint, workflow, and tenant configuration",
-    domain: "integration",
-    owners: ["@integration-team"],
-    tags: ["integration", "stripe", "payments"],
-    stability: "experimental"
+    title: "Collect Card Payment",
+    description: "Charge a customer using the tenant Stripe connection and record settlement details.",
+    domain: "payments",
+    owners: [OwnersEnum2.PlatformCore],
+    tags: [TagsEnum2.Marketplace, "stripe"],
+    stability: StabilityEnum2.Experimental
   },
-  integrations: [
-    { key: "integration-stripe.integration.psp", version: "1.0.0" }
-  ],
-  workflows: [{ key: "integration-stripe.workflow.payment", version: "1.0.0" }],
-  policies: [{ key: "integration-stripe.policy.payments", version: "1.0.0" }],
-  docs: [
-    "docs.examples.integration-stripe",
-    "docs.examples.integration-stripe.usage"
-  ]
-});
+  definition: {
+    entryStepId: "prepare",
+    steps: [
+      {
+        id: "prepare",
+        type: "automation",
+        label: "Prepare charge parameters",
+        action: {
+          operation: { key: "payments.prepareCharge", version: "1.0.0" }
+        }
+      },
+      {
+        id: "charge",
+        type: "automation",
+        label: "Charge card via Stripe",
+        action: {
+          operation: { key: "payments.stripe.chargeCard", version: "1.0.0" }
+        }
+      },
+      {
+        id: "confirm",
+        type: "automation",
+        label: "Confirm settlement",
+        action: {
+          operation: { key: "payments.recordSettlement", version: "1.0.0" }
+        }
+      }
+    ],
+    transitions: [
+      { from: "prepare", to: "charge" },
+      { from: "charge", to: "confirm", condition: "output.success === true" }
+    ]
+  }
+};
 export {
   stripeLiveConnection,
   example_default as example,