@contractspec/example.integration-stripe 3.7.16 → 3.7.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,114 +1 @@
1
- // src/workflow.ts
2
- import {
3
- OwnersEnum,
4
- StabilityEnum,
5
- TagsEnum
6
- } from "@contractspec/lib.contracts-spec/ownership";
7
- import { defineWorkflow } from "@contractspec/lib.contracts-spec/workflow";
8
- var collectPaymentWorkflow = defineWorkflow({
9
- meta: {
10
- key: "integration-stripe.workflow.payment",
11
- version: "1.0.0",
12
- title: "Collect Card Payment",
13
- description: "Charge a customer using the tenant Stripe connection and record settlement details.",
14
- domain: "payments",
15
- owners: [OwnersEnum.PlatformCore],
16
- tags: [TagsEnum.Marketplace, "stripe"],
17
- stability: StabilityEnum.Experimental
18
- },
19
- definition: {
20
- entryStepId: "prepare",
21
- steps: [
22
- {
23
- id: "prepare",
24
- type: "automation",
25
- label: "Prepare charge parameters",
26
- action: {
27
- operation: { key: "payments.prepareCharge", version: "1.0.0" }
28
- }
29
- },
30
- {
31
- id: "charge",
32
- type: "automation",
33
- label: "Charge card via Stripe",
34
- action: {
35
- operation: { key: "payments.stripe.chargeCard", version: "1.0.0" }
36
- }
37
- },
38
- {
39
- id: "confirm",
40
- type: "automation",
41
- label: "Confirm settlement",
42
- action: {
43
- operation: { key: "payments.recordSettlement", version: "1.0.0" }
44
- }
45
- }
46
- ],
47
- transitions: [
48
- { from: "prepare", to: "charge" },
49
- { from: "charge", to: "confirm", condition: "output.success === true" }
50
- ]
51
- }
52
- });
53
-
54
- // src/blueprint.ts
55
- import { defineAppConfig } from "@contractspec/lib.contracts-spec/app-config/spec";
56
- import {
57
- OwnersEnum as OwnersEnum2,
58
- StabilityEnum as StabilityEnum2,
59
- TagsEnum as TagsEnum2
60
- } from "@contractspec/lib.contracts-spec/ownership";
61
- var artisanStripeBlueprint = defineAppConfig({
62
- meta: {
63
- key: "artisan.payments.stripe",
64
- version: "1.0.0",
65
- appId: "artisan",
66
- title: "ArtisanOS Stripe Payments",
67
- description: "Blueprint enabling card payments for ArtisanOS merchants via the Stripe integration.",
68
- domain: "payments",
69
- owners: [OwnersEnum2.PlatformCore],
70
- tags: [TagsEnum2.Marketplace, "stripe", "payments"],
71
- stability: StabilityEnum2.Experimental
72
- },
73
- capabilities: {
74
- enabled: [{ key: "payments.psp", version: "1.0.0" }]
75
- },
76
- integrationSlots: [
77
- {
78
- slotId: "primary-payments",
79
- requiredCategory: "payments",
80
- allowedModes: ["managed", "byok"],
81
- requiredCapabilities: [{ key: "payments.psp", version: "1.0.0" }],
82
- required: true,
83
- description: "Primary card processor slot. Bind the tenant Stripe connection here."
84
- }
85
- ],
86
- branding: {
87
- appNameKey: "artisan.payments.appName",
88
- assets: [
89
- { type: "logo", url: "https://cdn.artisanos.dev/branding/logo.png" },
90
- {
91
- type: "favicon",
92
- url: "https://cdn.artisanos.dev/branding/favicon.ico"
93
- }
94
- ],
95
- colorTokens: {
96
- primary: "colors.brand.primary",
97
- secondary: "colors.brand.secondary"
98
- }
99
- },
100
- translationCatalog: {
101
- key: "artisan.payments.catalog",
102
- version: "1.0.0"
103
- },
104
- workflows: {
105
- collectPayment: {
106
- key: collectPaymentWorkflow.meta.key,
107
- version: collectPaymentWorkflow.meta.version
108
- }
109
- },
110
- notes: "Install this blueprint and pair it with the Stripe integration connection to enable card collection."
111
- });
112
- export {
113
- artisanStripeBlueprint
114
- };
1
+ import{OwnersEnum as q,StabilityEnum as v,TagsEnum as x}from"@contractspec/lib.contracts-spec/ownership";import{defineWorkflow as z}from"@contractspec/lib.contracts-spec/workflow/spec";var j=z({meta:{key:"integration-stripe.workflow.payment",version:"1.0.0",title:"Collect Card Payment",description:"Charge a customer using the tenant Stripe connection and record settlement details.",domain:"payments",owners:[q.PlatformCore],tags:[x.Marketplace,"stripe"],stability:v.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"}]}});import{defineAppConfig as B}from"@contractspec/lib.contracts-spec/app-config/spec";import{OwnersEnum as D,StabilityEnum as F,TagsEnum as G}from"@contractspec/lib.contracts-spec/ownership";var N=B({meta:{key:"artisan.payments.stripe",version:"1.0.0",appId:"artisan",title:"ArtisanOS Stripe Payments",description:"Blueprint enabling card payments for ArtisanOS merchants via the Stripe integration.",domain:"payments",owners:[D.PlatformCore],tags:[G.Marketplace,"stripe","payments"],stability:F.Experimental},capabilities:{enabled:[{key:"payments.psp",version:"1.0.0"}]},integrationSlots:[{slotId:"primary-payments",requiredCategory:"payments",allowedModes:["managed","byok"],requiredCapabilities:[{key:"payments.psp",version:"1.0.0"}],required:!0,description:"Primary card processor slot. Bind the tenant Stripe connection here."}],branding:{appNameKey:"artisan.payments.appName",assets:[{type:"logo",url:"https://cdn.artisanos.dev/branding/logo.png"},{type:"favicon",url:"https://cdn.artisanos.dev/branding/favicon.ico"}],colorTokens:{primary:"colors.brand.primary",secondary:"colors.brand.secondary"}},translationCatalog:{key:"artisan.payments.catalog",version:"1.0.0"},workflows:{collectPayment:{key:j.meta.key,version:j.meta.version}},notes:"Install this blueprint and pair it with the Stripe integration connection to enable card collection."});export{N as artisanStripeBlueprint};
@@ -1,99 +1 @@
1
- // src/integration.ts
2
- import { defineIntegration } from "@contractspec/lib.contracts-integrations";
3
- import {
4
- OwnersEnum,
5
- StabilityEnum,
6
- TagsEnum
7
- } from "@contractspec/lib.contracts-spec/ownership";
8
- import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
9
- var StripeConfigModel = defineSchemaModel({
10
- name: "StripePaymentsIntegrationConfig",
11
- description: "Managed configuration required to connect a Stripe account.",
12
- fields: {
13
- accountId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
14
- webhookEndpoint: {
15
- type: ScalarTypeEnum.String_unsecure(),
16
- isOptional: false
17
- }
18
- }
19
- });
20
- var StripeSecretModel = defineSchemaModel({
21
- name: "StripePaymentsIntegrationSecret",
22
- description: "Secret material stored out-of-band for the Stripe provider.",
23
- fields: {
24
- apiKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
25
- webhookSecret: {
26
- type: ScalarTypeEnum.String_unsecure(),
27
- isOptional: false
28
- }
29
- }
30
- });
31
- var StripePaymentsIntegrationSpec = defineIntegration({
32
- meta: {
33
- key: "integration-stripe.integration.psp",
34
- version: "1.0.0",
35
- title: "Stripe Payments Integration",
36
- description: "Integration contract for managed or BYOK Stripe card processing.",
37
- domain: "payments",
38
- category: "payments",
39
- owners: [OwnersEnum.PlatformCore],
40
- tags: [TagsEnum.Marketplace, "stripe", "payments"],
41
- stability: StabilityEnum.Experimental
42
- },
43
- supportedModes: ["managed", "byok"],
44
- capabilities: {
45
- provides: [{ key: "payments.psp", version: "1.0.0" }]
46
- },
47
- configSchema: {
48
- schema: StripeConfigModel,
49
- example: {
50
- accountId: "acct_demo_artisan",
51
- webhookEndpoint: "https://pay.artisanos.dev/webhooks/stripe"
52
- }
53
- },
54
- secretSchema: {
55
- schema: StripeSecretModel,
56
- example: {
57
- apiKey: "sk_live_redacted",
58
- webhookSecret: "whsec_redacted"
59
- }
60
- },
61
- healthCheck: {
62
- method: "ping",
63
- timeoutMs: 5000
64
- },
65
- docsUrl: "https://docs.stripe.com",
66
- constraints: {
67
- rateLimit: {
68
- rpm: 1000
69
- }
70
- },
71
- byokSetup: {
72
- setupInstructions: "Create a restricted API key and webhook endpoint, then bind the secret reference to the tenant connection.",
73
- requiredScopes: ["charges:write", "customers:read", "webhooks:write"]
74
- }
75
- });
76
-
77
- // src/connection.sample.ts
78
- var stripeLiveConnection = {
79
- meta: {
80
- id: "conn-stripe-live",
81
- tenantId: "artisan-co",
82
- integrationKey: StripePaymentsIntegrationSpec.meta.key,
83
- integrationVersion: StripePaymentsIntegrationSpec.meta.version,
84
- label: "Stripe Production",
85
- environment: "production",
86
- createdAt: "2026-01-01T00:00:00.000Z",
87
- updatedAt: "2026-01-01T00:00:00.000Z"
88
- },
89
- ownershipMode: "managed",
90
- config: {
91
- accountId: "acct_xxx"
92
- },
93
- secretProvider: "vault",
94
- secretRef: "vault://integrations/artisan-co/conn-stripe-live",
95
- status: "connected"
96
- };
97
- export {
98
- stripeLiveConnection
99
- };
1
+ import{defineIntegration as i}from"@contractspec/lib.contracts-integrations";import{OwnersEnum as e,StabilityEnum as r,TagsEnum as a}from"@contractspec/lib.contracts-spec/ownership";import{defineSchemaModel as o,ScalarTypeEnum as t}from"@contractspec/lib.schema";var s=o({name:"StripePaymentsIntegrationConfig",description:"Managed configuration required to connect a Stripe account.",fields:{accountId:{type:t.String_unsecure(),isOptional:!1},webhookEndpoint:{type:t.String_unsecure(),isOptional:!1}}}),c=o({name:"StripePaymentsIntegrationSecret",description:"Secret material stored out-of-band for the Stripe provider.",fields:{apiKey:{type:t.String_unsecure(),isOptional:!1},webhookSecret:{type:t.String_unsecure(),isOptional:!1}}}),n=i({meta:{key:"integration-stripe.integration.psp",version:"1.0.0",title:"Stripe Payments Integration",description:"Integration contract for managed or BYOK Stripe card processing.",domain:"payments",category:"payments",owners:[e.PlatformCore],tags:[a.Marketplace,"stripe","payments"],stability:r.Experimental},supportedModes:["managed","byok"],capabilities:{provides:[{key:"payments.psp",version:"1.0.0"}]},configSchema:{schema:s,example:{accountId:"acct_demo_artisan",webhookEndpoint:"https://pay.artisanos.dev/webhooks/stripe"}},secretSchema:{schema:c,example:{apiKey:"sk_live_redacted",webhookSecret:"whsec_redacted"}},healthCheck:{method:"ping",timeoutMs:5000},docsUrl:"https://docs.stripe.com",constraints:{rateLimit:{rpm:1000}},byokSetup:{setupInstructions:"Create a restricted API key and webhook endpoint, then bind the secret reference to the tenant connection.",requiredScopes:["charges:write","customers:read","webhooks:write"]}});var I={meta:{id:"conn-stripe-live",tenantId:"artisan-co",integrationKey:n.meta.key,integrationVersion:n.meta.version,label:"Stripe Production",environment:"production",createdAt:"2026-01-01T00:00:00.000Z",updatedAt:"2026-01-01T00:00:00.000Z"},ownershipMode:"managed",config:{accountId:"acct_xxx"},secretProvider:"vault",secretRef:"vault://integrations/artisan-co/conn-stripe-live",status:"connected"};export{I as stripeLiveConnection};
@@ -1,39 +1,15 @@
1
- // src/docs/integration-stripe.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
- var blocks = [
4
- {
5
- id: "docs.examples.integration-stripe",
6
- title: "Integration Example — Stripe Payments",
7
- summary: "How to wire IntegrationSpec/TenantAppConfig + blueprint + workflow to enable Stripe-backed payments.",
8
- kind: "reference",
9
- visibility: "public",
10
- route: "/docs/examples/integration-stripe",
11
- tags: ["stripe", "payments", "integrations", "example"],
12
- body: `## Included
1
+ import{registerDocBlocks as m}from"@contractspec/lib.contracts-spec/docs";var f=[{id:"docs.examples.integration-stripe",title:"Integration Example — Stripe Payments",summary:"How to wire IntegrationSpec/TenantAppConfig + blueprint + workflow to enable Stripe-backed payments.",kind:"reference",visibility:"public",route:"/docs/examples/integration-stripe",tags:["stripe","payments","integrations","example"],body:`## Included
13
2
  - App blueprint enabling \`payments.psp\` capability.
14
3
  - Workflow invoking Stripe operations (prepare → charge → confirm).
15
4
  - Tenant app config binding workflow to an IntegrationConnection.
16
5
 
17
6
  ## Notes
18
7
  - Secrets live in secret providers; connection config is non-secret.
19
- - Use \`ctx.resolvedAppConfig\` in operation executors to access integrations, branding, and translations.`
20
- },
21
- {
22
- id: "docs.examples.integration-stripe.usage",
23
- title: "Stripe Integration Example — Usage",
24
- summary: "How to use the blueprint, workflow, and tenant config together.",
25
- kind: "usage",
26
- visibility: "public",
27
- route: "/docs/examples/integration-stripe/usage",
28
- tags: ["stripe", "usage"],
29
- body: `## Usage
8
+ - Use \`ctx.resolvedAppConfig\` in operation executors to access integrations, branding, and translations.`},{id:"docs.examples.integration-stripe.usage",title:"Stripe Integration Example — Usage",summary:"How to use the blueprint, workflow, and tenant config together.",kind:"usage",visibility:"public",route:"/docs/examples/integration-stripe/usage",tags:["stripe","usage"],body:`## Usage
30
9
  1) Register the blueprint + workflow + catalog in your registry.
31
10
  2) Persist an IntegrationConnection (see connection sample).
32
11
  3) Bind the tenant app config to the connection.
33
12
 
34
13
  ## Guardrails
35
14
  - Never log secrets.
36
- - Keep payment semantics spec-defined; gate breaking changes behind flags.`
37
- }
38
- ];
39
- registerDocBlocks(blocks);
15
+ - Keep payment semantics spec-defined; gate breaking changes behind flags.`}];m(f);
@@ -1,39 +1,15 @@
1
- // src/docs/integration-stripe.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
- var blocks = [
4
- {
5
- id: "docs.examples.integration-stripe",
6
- title: "Integration Example — Stripe Payments",
7
- summary: "How to wire IntegrationSpec/TenantAppConfig + blueprint + workflow to enable Stripe-backed payments.",
8
- kind: "reference",
9
- visibility: "public",
10
- route: "/docs/examples/integration-stripe",
11
- tags: ["stripe", "payments", "integrations", "example"],
12
- body: `## Included
1
+ import{registerDocBlocks as f}from"@contractspec/lib.contracts-spec/docs";var h=[{id:"docs.examples.integration-stripe",title:"Integration Example — Stripe Payments",summary:"How to wire IntegrationSpec/TenantAppConfig + blueprint + workflow to enable Stripe-backed payments.",kind:"reference",visibility:"public",route:"/docs/examples/integration-stripe",tags:["stripe","payments","integrations","example"],body:`## Included
13
2
  - App blueprint enabling \`payments.psp\` capability.
14
3
  - Workflow invoking Stripe operations (prepare → charge → confirm).
15
4
  - Tenant app config binding workflow to an IntegrationConnection.
16
5
 
17
6
  ## Notes
18
7
  - Secrets live in secret providers; connection config is non-secret.
19
- - Use \`ctx.resolvedAppConfig\` in operation executors to access integrations, branding, and translations.`
20
- },
21
- {
22
- id: "docs.examples.integration-stripe.usage",
23
- title: "Stripe Integration Example — Usage",
24
- summary: "How to use the blueprint, workflow, and tenant config together.",
25
- kind: "usage",
26
- visibility: "public",
27
- route: "/docs/examples/integration-stripe/usage",
28
- tags: ["stripe", "usage"],
29
- body: `## Usage
8
+ - Use \`ctx.resolvedAppConfig\` in operation executors to access integrations, branding, and translations.`},{id:"docs.examples.integration-stripe.usage",title:"Stripe Integration Example — Usage",summary:"How to use the blueprint, workflow, and tenant config together.",kind:"usage",visibility:"public",route:"/docs/examples/integration-stripe/usage",tags:["stripe","usage"],body:`## Usage
30
9
  1) Register the blueprint + workflow + catalog in your registry.
31
10
  2) Persist an IntegrationConnection (see connection sample).
32
11
  3) Bind the tenant app config to the connection.
33
12
 
34
13
  ## Guardrails
35
14
  - Never log secrets.
36
- - Keep payment semantics spec-defined; gate breaking changes behind flags.`
37
- }
38
- ];
39
- registerDocBlocks(blocks);
15
+ - Keep payment semantics spec-defined; gate breaking changes behind flags.`}];f(h);
@@ -1,33 +1 @@
1
- // src/example.ts
2
- import { defineExample } from "@contractspec/lib.contracts-spec";
3
- var example = defineExample({
4
- meta: {
5
- key: "integration-stripe",
6
- version: "1.0.0",
7
- title: "Integration — Stripe Payments",
8
- description: "Wire AppBlueprint + Workflow + TenantAppConfig to enable Stripe-backed payments (spec-first integration pattern).",
9
- kind: "integration",
10
- visibility: "public",
11
- stability: "experimental",
12
- owners: ["@platform.core"],
13
- tags: ["stripe", "payments", "integration", "blueprint", "workflow"]
14
- },
15
- docs: {
16
- rootDocId: "docs.examples.integration-stripe",
17
- usageDocId: "docs.examples.integration-stripe.usage"
18
- },
19
- entrypoints: {
20
- packageName: "@contractspec/example.integration-stripe",
21
- docs: "./docs"
22
- },
23
- surfaces: {
24
- templates: true,
25
- sandbox: { enabled: true, modes: ["markdown", "specs"] },
26
- studio: { enabled: true, installable: true },
27
- mcp: { enabled: true }
28
- }
29
- });
30
- var example_default = example;
31
- export {
32
- example_default as default
33
- };
1
+ import{defineExample as g}from"@contractspec/lib.contracts-spec";var h=g({meta:{key:"integration-stripe",version:"1.0.0",title:"Integration — Stripe Payments",description:"Wire AppBlueprint + Workflow + TenantAppConfig to enable Stripe-backed payments (spec-first integration pattern).",kind:"integration",visibility:"public",stability:"experimental",owners:["@platform.core"],tags:["stripe","payments","integration","blueprint","workflow"]},docs:{rootDocId:"docs.examples.integration-stripe",usageDocId:"docs.examples.integration-stripe.usage"},entrypoints:{packageName:"@contractspec/example.integration-stripe",docs:"./docs"},surfaces:{templates:!0,sandbox:{enabled:!0,modes:["markdown","specs"]},studio:{enabled:!0,installable:!0},mcp:{enabled:!0}}}),q=h;export{q as default};