@drawbridge/drawbridge-utils 0.0.152 → 0.0.154
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.
- package/dist/connections/index.cjs +233 -89
- package/dist/connections/index.d.cts +332 -91
- package/dist/connections/index.d.ts +332 -91
- package/dist/connections/index.js +230 -88
- package/dist/providers.cjs +244 -94
- package/dist/providers.d.cts +37 -15
- package/dist/providers.d.ts +37 -15
- package/dist/providers.js +241 -93
- package/package.json +1 -1
package/dist/providers.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { vendors, mergeSettings, connections } from './connections/index.js';
|
|
2
2
|
import { decrypt, encrypt } from './encrypt.js';
|
|
3
3
|
import { slugify } from './slugify.js';
|
|
4
4
|
import './connections/oauth.js';
|
|
@@ -58,27 +58,26 @@ import 'slugify';
|
|
|
58
58
|
// `requires` and auth.oauth.client did not have to change when the storage
|
|
59
59
|
// moved into the database.
|
|
60
60
|
//
|
|
61
|
-
//
|
|
62
|
-
//
|
|
63
|
-
// and encrypting around
|
|
61
|
+
// A manifest declares the fields it spends under `provider.vendors.<vendor>`,
|
|
62
|
+
// connections/index.js merges every manifest's declarations into one entry per
|
|
63
|
+
// vendor, and this module is only the reading, memoizing and encrypting around
|
|
64
|
+
// that. The `provider` collection is keyed the same way: one row per vendor.
|
|
64
65
|
//
|
|
65
|
-
// Object.hasOwn, not `
|
|
66
|
-
// prototype chain, and
|
|
67
|
-
//
|
|
68
|
-
//
|
|
66
|
+
// Object.hasOwn, not `vendors[ slug ] ||` — a bare property read walks the
|
|
67
|
+
// prototype chain, and vendors[ 'constructor' ] is a function whose .length is
|
|
68
|
+
// 1, so the route's "does this vendor exist" guard passed for it and reached the
|
|
69
|
+
// database before throwing.
|
|
69
70
|
const providerFields = ( slug ) => (
|
|
70
|
-
Object.hasOwn(
|
|
71
|
+
Object.hasOwn( vendors, slug ) ? vendors[ slug ].fields : []
|
|
71
72
|
);
|
|
72
73
|
|
|
73
74
|
// The vendors an admin can configure, in a stable order.
|
|
74
75
|
//
|
|
75
|
-
// DERIVED FROM WHO DECLARES A
|
|
76
|
-
//
|
|
76
|
+
// DERIVED FROM WHO DECLARES A VENDOR, not from the catalog: `webhook` is a
|
|
77
|
+
// connection with no vendor behind it — nothing to authenticate against and
|
|
77
78
|
// nothing to type — so it must not appear on a screen whose whole purpose is
|
|
78
79
|
// entering credentials.
|
|
79
|
-
const providerSlugs = () => Object.keys(
|
|
80
|
-
.filter( ( slug ) => connections[ slug ].provider )
|
|
81
|
-
.sort();
|
|
80
|
+
const providerSlugs = () => Object.keys( vendors ).sort();
|
|
82
81
|
|
|
83
82
|
// LIVE IS DERIVED, never stored. A stored flag is a second thing to keep in
|
|
84
83
|
// sync and goes stale the moment a row is edited by hand.
|
|
@@ -171,6 +170,29 @@ const providerSettings = async ({ controller, slug }) => {
|
|
|
171
170
|
|
|
172
171
|
};
|
|
173
172
|
|
|
173
|
+
// EVERYTHING A CONNECTION SPENDS, merged across the vendors its manifest
|
|
174
|
+
// declares. `drawbridge` reads SendGrid, Twilio and HubSpot as one object, the
|
|
175
|
+
// way it did when they sat on one row — the row split, the readers did not.
|
|
176
|
+
//
|
|
177
|
+
// Safe to merge because build() refuses a manifest whose vendors share a field
|
|
178
|
+
// key. Each vendor read is memoized on its own, so three vendors are three Map
|
|
179
|
+
// lookups inside the window.
|
|
180
|
+
const vendorSettings = async ({ controller, slug }) => {
|
|
181
|
+
|
|
182
|
+
const declared = Object.hasOwn( connections, slug ) ? Object.keys( connections[ slug ].provider?.vendors || {} ) : [];
|
|
183
|
+
|
|
184
|
+
let merged = {};
|
|
185
|
+
|
|
186
|
+
for( const vendor of declared ){
|
|
187
|
+
|
|
188
|
+
merged = { ...merged, ...await providerSettings({ controller, slug : vendor }) };
|
|
189
|
+
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
return merged;
|
|
193
|
+
|
|
194
|
+
};
|
|
195
|
+
|
|
174
196
|
// Write a vendor's credentials.
|
|
175
197
|
//
|
|
176
198
|
// ONLY THE DECLARED FIELDS. The body arrives over the wire, so anything in it
|
|
@@ -325,4 +347,4 @@ const providerCredentials = async ({ controller }) => {
|
|
|
325
347
|
|
|
326
348
|
};
|
|
327
349
|
|
|
328
|
-
export { clearProviderMemo, isLive, mask, providerCredentials, providerEnvNames, providerFields, providerMemo, providerSettings, providerSlugs, saveProviderSettings };
|
|
350
|
+
export { clearProviderMemo, isLive, mask, providerCredentials, providerEnvNames, providerFields, providerMemo, providerSettings, providerSlugs, saveProviderSettings, vendorSettings, vendors };
|
package/dist/providers.js
CHANGED
|
@@ -721,10 +721,16 @@ var attentive_default2 = {
|
|
|
721
721
|
// `redact` marks a secret — never returned by the api, and blank on save means
|
|
722
722
|
// keep the stored value. `required` drives the live check.
|
|
723
723
|
provider: {
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
724
|
+
vendors: {
|
|
725
|
+
attentive: {
|
|
726
|
+
fields: [
|
|
727
|
+
{ input: "text", key: "clientId", credential: "ATTENTIVE_OAUTH_CLIENT_ID", label: "Client ID", message: "From our app's registration in the Attentive developer portal.", required: true },
|
|
728
|
+
{ input: "password", key: "clientSecret", credential: "ATTENTIVE_OAUTH_CLIENT_SECRET", label: "Client secret", message: "Beside the Client ID in the Attentive developer portal.", redact: true, required: true }
|
|
729
|
+
],
|
|
730
|
+
icon: attentive_default,
|
|
731
|
+
name: "Attentive"
|
|
732
|
+
}
|
|
733
|
+
}
|
|
728
734
|
},
|
|
729
735
|
requires: [
|
|
730
736
|
"ATTENTIVE_OAUTH_CLIENT_ID",
|
|
@@ -990,6 +996,43 @@ var drawbridge_default = `<svg width="500" height="500" viewBox="0 0 500 500" fi
|
|
|
990
996
|
</defs>
|
|
991
997
|
</svg>`;
|
|
992
998
|
|
|
999
|
+
// lib/connections/icons/hubspot.js
|
|
1000
|
+
var hubspot_default = `<svg width="500" height="500" viewBox="0 0 500 500" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
1001
|
+
<rect width="500" height="500" fill="#FF7A59"/>
|
|
1002
|
+
<circle cx="290" cy="290" r="78" stroke="white" stroke-width="30"/>
|
|
1003
|
+
<circle cx="290" cy="290" r="18" fill="white"/>
|
|
1004
|
+
<path d="M290 212V150" stroke="white" stroke-width="30" stroke-linecap="round"/>
|
|
1005
|
+
<circle cx="290" cy="125" r="28" fill="white"/>
|
|
1006
|
+
<path d="M270 137L172 96" stroke="white" stroke-width="22" stroke-linecap="round"/>
|
|
1007
|
+
<circle cx="160" cy="91" r="20" fill="white"/>
|
|
1008
|
+
<path d="M233 347L184 396" stroke="white" stroke-width="26" stroke-linecap="round"/>
|
|
1009
|
+
<circle cx="172" cy="408" r="22" fill="white"/>
|
|
1010
|
+
</svg>`;
|
|
1011
|
+
|
|
1012
|
+
// lib/connections/icons/sendgrid.js
|
|
1013
|
+
var sendgrid_default = `<svg width="500" height="500" viewBox="0 0 500 500" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
1014
|
+
<rect width="500" height="500" fill="#F1FAFF"/>
|
|
1015
|
+
<g clip-path="url(#clip0_1011_2743)">
|
|
1016
|
+
<path d="M366.676 134.534V289.172H289.203V366.487H134.258L134.258 289.171L134.256 289.172V211.851H211.729V134.534H366.676Z" fill="#9DD6E3"/>
|
|
1017
|
+
<path d="M134.258 366.488H211.731V289.169H134.258V366.488Z" fill="#3F72AB"/>
|
|
1018
|
+
<path d="M289.203 289.172H366.677V211.852H289.203V289.172Z" fill="#00A9D1"/>
|
|
1019
|
+
<path d="M211.729 211.853H289.202V134.534H211.729V211.853Z" fill="#00A9D1"/>
|
|
1020
|
+
<path d="M211.729 289.17H289.202V211.852H211.729V289.17Z" fill="#2191C4"/>
|
|
1021
|
+
<path d="M289.203 211.853H366.677V134.534H289.203V211.853Z" fill="#3F72AB"/>
|
|
1022
|
+
</g>
|
|
1023
|
+
<defs>
|
|
1024
|
+
<clipPath id="clip0_1011_2743">
|
|
1025
|
+
<rect width="232.42" height="231.956" fill="white" transform="translate(134.256 134.534)"/>
|
|
1026
|
+
</clipPath>
|
|
1027
|
+
</defs>
|
|
1028
|
+
</svg>`;
|
|
1029
|
+
|
|
1030
|
+
// lib/connections/icons/twilio.js
|
|
1031
|
+
var twilio_default = `<svg width="500" height="500" viewBox="0 0 500 500" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
1032
|
+
<rect width="500" height="500" fill="#F22F46"/>
|
|
1033
|
+
<path d="M250 134.954C186.341 134.954 134.954 186.341 134.954 250C134.954 313.659 186.341 365.047 250 365.047C313.659 365.047 365.047 313.659 365.047 250C365.047 186.341 313.659 134.954 250 134.954ZM250 334.368C203.215 334.368 165.633 296.786 165.633 250C165.633 203.215 203.215 165.633 250 165.633C296.786 165.633 334.368 203.215 334.368 250C334.368 296.786 296.786 334.368 250 334.368ZM302.155 221.622C302.155 234.661 291.417 245.399 278.378 245.399C265.34 245.399 254.602 234.661 254.602 221.622C254.602 208.584 265.34 197.846 278.378 197.846C291.417 197.846 302.155 208.584 302.155 221.622ZM302.155 278.378C302.155 291.417 291.417 302.155 278.378 302.155C265.34 302.155 254.602 291.417 254.602 278.378C254.602 265.34 265.34 254.602 278.378 254.602C291.417 254.602 302.155 265.34 302.155 278.378ZM245.399 278.378C245.399 291.417 234.661 302.155 221.622 302.155C208.584 302.155 197.846 291.417 197.846 278.378C197.846 265.34 208.584 254.602 221.622 254.602C234.661 254.602 245.399 265.34 245.399 278.378ZM245.399 221.622C245.399 234.661 234.661 245.399 221.622 245.399C208.584 245.399 197.846 234.661 197.846 221.622C197.846 208.584 208.584 197.846 221.622 197.846C234.661 197.846 245.399 208.584 245.399 221.622Z" fill="white"/>
|
|
1034
|
+
</svg>`;
|
|
1035
|
+
|
|
993
1036
|
// lib/transactions.js
|
|
994
1037
|
import { currentTraceId } from "@drawbridge/drawbridge-telemetry";
|
|
995
1038
|
|
|
@@ -2156,37 +2199,56 @@ var drawbridge_default2 = {
|
|
|
2156
2199
|
//
|
|
2157
2200
|
// They belong on THIS manifest because this is the connection that sends: the
|
|
2158
2201
|
// email, sms and segment hooks below are the only things that spend them, and
|
|
2159
|
-
// a private connection is still where a vendor fact lives.
|
|
2202
|
+
// a private connection is still where a vendor fact lives. They are THREE
|
|
2203
|
+
// VENDORS, not one, and each is its own row and its own admin card — so
|
|
2204
|
+
// SendGrid reads live on a deployment that never configured Twilio, instead
|
|
2205
|
+
// of one card for all three that could only ever be as live as its weakest.
|
|
2160
2206
|
//
|
|
2161
2207
|
// UNLIKE every public vendor, none of these appear in `requires` — see the
|
|
2162
2208
|
// comment there. Availability and configuration are different questions, and a
|
|
2163
2209
|
// missing CRM token must not take every base workflow step away.
|
|
2210
|
+
//
|
|
2211
|
+
// ponytail: the field keys keep the names they had on the shared row
|
|
2212
|
+
// (smsSid, hubspotToken) so the readers destructuring vendorSettings() did
|
|
2213
|
+
// not move. Rename them to sid/token when those readers are next touched.
|
|
2164
2214
|
provider: {
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
// mail are email. Requiring Twilio here made the whole drawbridge
|
|
2179
|
-
// provider read not-live on a deployment that never sends SMS, over a
|
|
2180
|
-
// channel it was not using.
|
|
2181
|
-
//
|
|
2215
|
+
vendors: {
|
|
2216
|
+
sendgrid: {
|
|
2217
|
+
fields: [
|
|
2218
|
+
{ input: "email", key: "accountSender", credential: "SENDGRID_FROM_ADDRESS", label: "Account sender", message: "Verification codes and security alerts send from here.", required: true },
|
|
2219
|
+
{ input: "password", key: "apiKey", credential: "SENDGRID_API_KEY", label: "SendGrid API key", message: "SendGrid dashboard, Settings, API Keys \u2014 full access for sends.", redact: true, required: true },
|
|
2220
|
+
// Optional: SENDGRID_SEND_FROM_ADDRESS is not boot-required in sync
|
|
2221
|
+
// either. Unset, it degrades to the account sender rather than
|
|
2222
|
+
// refusing to start.
|
|
2223
|
+
{ input: "email", key: "leadSender", credential: "SENDGRID_SEND_FROM_ADDRESS", label: "Lead sender", message: "The default for lead-facing mail when a merchant has not verified their own domain." }
|
|
2224
|
+
],
|
|
2225
|
+
icon: sendgrid_default,
|
|
2226
|
+
name: "SendGrid"
|
|
2227
|
+
},
|
|
2182
2228
|
// Missing, SMS is LOCKED DOWN rather than broken: every send path
|
|
2183
2229
|
// refuses cleanly (queue/notification.js cancels, the otc stream skips
|
|
2184
2230
|
// and logs), the number-purchase routes deny, and identityDefaults.sms
|
|
2185
|
-
// hides the org's SMS settings entirely.
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2231
|
+
// hides the org's SMS settings entirely. The card reads not live, which
|
|
2232
|
+
// is the truth about Twilio and says nothing about email.
|
|
2233
|
+
twilio: {
|
|
2234
|
+
fields: [
|
|
2235
|
+
{ input: "text", key: "smsFrom", credential: "TWILIO_ACCOUNT_FROM", label: "SMS number", message: "Without Twilio credentials, SMS is disabled across the platform.", required: true },
|
|
2236
|
+
{ input: "password", key: "smsSid", credential: "TWILIO_ACCOUNT_SID", label: "Twilio account SID", message: "Twilio console home \u2014 the AC\u2026 identifier on the account dashboard.", redact: true, required: true },
|
|
2237
|
+
{ input: "password", key: "smsToken", credential: "TWILIO_AUTH_TOKEN", label: "Twilio auth token", message: "Beside the account SID on the Twilio console dashboard.", redact: true, required: true }
|
|
2238
|
+
],
|
|
2239
|
+
icon: twilio_default,
|
|
2240
|
+
name: "Twilio"
|
|
2241
|
+
},
|
|
2242
|
+
// The CRM sync is best-effort internal tooling and no-ops without a
|
|
2243
|
+
// token. Not live here costs nothing a merchant can see.
|
|
2244
|
+
hubspot: {
|
|
2245
|
+
fields: [
|
|
2246
|
+
{ input: "password", key: "hubspotToken", credential: "HUBSPOT_ACCESS_TOKEN", label: "HubSpot access token", message: "Drawbridge's own CRM portal. Internal \u2014 no merchant sees this.", redact: true, required: true }
|
|
2247
|
+
],
|
|
2248
|
+
icon: hubspot_default,
|
|
2249
|
+
name: "HubSpot"
|
|
2250
|
+
}
|
|
2251
|
+
}
|
|
2190
2252
|
},
|
|
2191
2253
|
// NOTHING, and HUBSPOT_ACCESS_TOKEN in particular must not be here.
|
|
2192
2254
|
//
|
|
@@ -2772,12 +2834,20 @@ var klaviyo_default2 = {
|
|
|
2772
2834
|
// DRAWBRIDGE'S OWN CREDENTIALS for this vendor, as opposed to a merchant's —
|
|
2773
2835
|
// what an admin types on the provider screen. Declared here rather than in a
|
|
2774
2836
|
// table in lib/providers.js, so a vendor's credentials sit beside the
|
|
2775
|
-
// `requires` that names the same variables.
|
|
2837
|
+
// `requires` that names the same variables. Keyed by the VENDOR that holds
|
|
2838
|
+
// them — here the vendor and the connection are the same thing, which is not
|
|
2839
|
+
// true of every manifest.
|
|
2776
2840
|
provider: {
|
|
2777
|
-
|
|
2778
|
-
|
|
2779
|
-
|
|
2780
|
-
|
|
2841
|
+
vendors: {
|
|
2842
|
+
klaviyo: {
|
|
2843
|
+
fields: [
|
|
2844
|
+
{ input: "text", key: "clientId", credential: "KLAVIYO_OAUTH_CLIENT_ID", label: "Client ID", message: "From our app in the Klaviyo developer portal (developers.klaviyo.com).", required: true },
|
|
2845
|
+
{ input: "password", key: "clientSecret", credential: "KLAVIYO_OAUTH_CLIENT_SECRET", label: "Client secret", message: "Beside the Client ID on the Klaviyo app.", redact: true, required: true }
|
|
2846
|
+
],
|
|
2847
|
+
icon: klaviyo_default,
|
|
2848
|
+
name: "Klaviyo"
|
|
2849
|
+
}
|
|
2850
|
+
}
|
|
2781
2851
|
},
|
|
2782
2852
|
requires: [
|
|
2783
2853
|
"KLAVIYO_OAUTH_CLIENT_ID",
|
|
@@ -3120,10 +3190,16 @@ var mailchimp_default2 = {
|
|
|
3120
3190
|
// what an admin types on the provider screen, beside the `requires` naming the
|
|
3121
3191
|
// same variables.
|
|
3122
3192
|
provider: {
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3193
|
+
vendors: {
|
|
3194
|
+
mailchimp: {
|
|
3195
|
+
fields: [
|
|
3196
|
+
{ input: "text", key: "clientId", credential: "MAILCHIMP_OAUTH_CLIENT_ID", label: "Client ID", message: "From our registered app \u2014 Mailchimp account, Extras, Registered apps.", required: true },
|
|
3197
|
+
{ input: "password", key: "clientSecret", credential: "MAILCHIMP_OAUTH_CLIENT_SECRET", label: "Client secret", message: "Beside the Client ID on the registered app.", redact: true, required: true }
|
|
3198
|
+
],
|
|
3199
|
+
icon: mailchimp_default,
|
|
3200
|
+
name: "Mailchimp"
|
|
3201
|
+
}
|
|
3202
|
+
}
|
|
3127
3203
|
},
|
|
3128
3204
|
// The OAuth client this deployment registered. Without both, the vendor drops
|
|
3129
3205
|
// out of availableConnections rather than offering a Connect button that
|
|
@@ -3933,7 +4009,9 @@ var shopify_default2 = {
|
|
|
3933
4009
|
enqueues: [{
|
|
3934
4010
|
data: { product: productId, providerId, shop: connection2.shop },
|
|
3935
4011
|
name: "workflow",
|
|
3936
|
-
|
|
4012
|
+
// The numeric id, not the gid: BullMQ refuses a custom id with a
|
|
4013
|
+
// colon in it, and every gid carries two.
|
|
4014
|
+
options: { jobId: "product.workflow.shopify." + context.id + "." + Date.now() },
|
|
3937
4015
|
queue: "product.shopify"
|
|
3938
4016
|
}],
|
|
3939
4017
|
message: "Product sync queued from Shopify webhook.",
|
|
@@ -4379,28 +4457,34 @@ var shopify_default2 = {
|
|
|
4379
4457
|
// name required by the manifest and enterable nowhere is a vendor that can
|
|
4380
4458
|
// never go live from the admin screen.
|
|
4381
4459
|
provider: {
|
|
4382
|
-
|
|
4383
|
-
|
|
4384
|
-
|
|
4385
|
-
|
|
4386
|
-
|
|
4387
|
-
|
|
4388
|
-
|
|
4389
|
-
|
|
4390
|
-
|
|
4391
|
-
|
|
4392
|
-
|
|
4393
|
-
|
|
4394
|
-
|
|
4395
|
-
|
|
4396
|
-
|
|
4397
|
-
|
|
4398
|
-
|
|
4399
|
-
|
|
4400
|
-
|
|
4401
|
-
|
|
4402
|
-
|
|
4403
|
-
|
|
4460
|
+
vendors: {
|
|
4461
|
+
shopify: {
|
|
4462
|
+
fields: [
|
|
4463
|
+
{ input: "text", key: "apiKey", credential: "SHOPIFY_API_KEY", label: "API key", message: "The app's Client ID \u2014 Dev Dashboard, the app, Settings.", required: true },
|
|
4464
|
+
{ input: "password", key: "apiSecret", credential: "SHOPIFY_API_SECRET", label: "API secret", message: "The app's Client secret, beside the Client ID in the app's settings.", redact: true, required: true },
|
|
4465
|
+
{ input: "text", key: "appHandle", credential: "SHOPIFY_APP_HANDLE", label: "App handle", message: "The app's URL handle (for example drawbridge-development), from the app's configuration.", required: true },
|
|
4466
|
+
{ input: "text", key: "listingUrl", credential: "SHOPIFY_APP_LISTING_URL", label: "App listing URL", message: 'Where "View on the Shopify App Store" sends merchants \u2014 the public listing, or the Dev Dashboard install link for the dev app.', required: true },
|
|
4467
|
+
// The usage meter's event handle, when the plan config's meter ever
|
|
4468
|
+
// changes: stored value overrides the built-in default
|
|
4469
|
+
// (events.order.handle) at the mint point, and `format : 'slug'`
|
|
4470
|
+
// normalizes it on save — a handle can carry no spaces or capitals,
|
|
4471
|
+
// and classification against it is case-sensitive. Optional: empty
|
|
4472
|
+
// means the default, and the sender still refuses any handle that
|
|
4473
|
+
// disagrees with the transaction it minted.
|
|
4474
|
+
{ format: "slug", input: "text", key: "orderEventHandle", label: "Order event handle", message: "Must match the usage meter's Handle field on the plan exactly \u2014 lowercase and hyphens. Leave empty to use drawbridge-orders.", required: false, setting: true },
|
|
4475
|
+
// The Partner API credential set — the ONE place meter billing is
|
|
4476
|
+
// observable (CHARGE_USAGE accrual events). Org id and numeric app
|
|
4477
|
+
// id come from the Partner Dashboard; the token from Settings →
|
|
4478
|
+
// Partner API clients (Manage-apps permission). All optional: the
|
|
4479
|
+
// accrual probe simply stays off until they exist.
|
|
4480
|
+
{ input: "text", key: "partnerOrgId", label: "Partner organization ID", message: "The number in the Partner Dashboard URL \u2014 partners.shopify.com/<this number>/\u2026 \u2014 NOT the admin organization_id from the app listing link.", required: false, setting: true },
|
|
4481
|
+
{ input: "text", key: "partnerAppId", label: "Partner app ID (numeric)", message: "The numeric id in the app's Partner Dashboard URL \u2014 not the Client ID.", required: false, setting: true },
|
|
4482
|
+
{ input: "password", key: "partnerToken", label: "Partner API token", message: "Partner Dashboard, Settings, Partner API clients \u2014 create one with Manage apps and paste the prtapi_ token.", redact: true, required: false, setting: true }
|
|
4483
|
+
],
|
|
4484
|
+
icon: shopify_default,
|
|
4485
|
+
name: "Shopify"
|
|
4486
|
+
}
|
|
4487
|
+
}
|
|
4404
4488
|
},
|
|
4405
4489
|
// A pre-launch integration: it only surfaces once the App Store listing
|
|
4406
4490
|
// exists and the app is fully configured. Requiring all four means it can
|
|
@@ -4881,8 +4965,19 @@ var implemented = (hooks, path) => {
|
|
|
4881
4965
|
var leaves = (node, path = []) => Object.entries(node || {}).flatMap(
|
|
4882
4966
|
([key, value]) => typeof value === "function" ? [[[...path, key].join("."), value]] : value && typeof value === "object" ? leaves(value, [...path, key]) : []
|
|
4883
4967
|
);
|
|
4968
|
+
var checkIcon = (owner, icon) => {
|
|
4969
|
+
if (typeof icon !== "string" || !icon.includes("<svg")) {
|
|
4970
|
+
throw new Error(owner + " needs an icon \u2014 the svg markup itself, not a path to one");
|
|
4971
|
+
}
|
|
4972
|
+
if (!icon.includes("viewBox")) {
|
|
4973
|
+
throw new Error(owner + " icon has no viewBox, so it cannot scale");
|
|
4974
|
+
}
|
|
4975
|
+
if (icon.includes("<image")) {
|
|
4976
|
+
throw new Error(owner + " icon wraps a raster \u2014 re-export it as vector shapes");
|
|
4977
|
+
}
|
|
4978
|
+
};
|
|
4884
4979
|
var build = (manifest) => {
|
|
4885
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t;
|
|
4980
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u;
|
|
4886
4981
|
if (!(manifest == null ? void 0 : manifest.slug)) throw new Error("A connection needs a slug");
|
|
4887
4982
|
if (!(manifest == null ? void 0 : manifest.title)) throw new Error(manifest.slug + " needs a title");
|
|
4888
4983
|
if (!(manifest == null ? void 0 : manifest.private) && !(manifest == null ? void 0 : manifest.feature)) throw new Error(manifest.slug + " needs a plan feature key");
|
|
@@ -4912,46 +5007,53 @@ var build = (manifest) => {
|
|
|
4912
5007
|
}
|
|
4913
5008
|
}
|
|
4914
5009
|
}
|
|
4915
|
-
|
|
4916
|
-
|
|
4917
|
-
|
|
4918
|
-
|
|
4919
|
-
|
|
4920
|
-
|
|
5010
|
+
if ((_c = manifest.provider) == null ? void 0 : _c.fields) {
|
|
5011
|
+
throw new Error(manifest.slug + " declares provider.fields \u2014 fields live under provider.vendors.<vendor> now, keyed by the vendor that holds them");
|
|
5012
|
+
}
|
|
5013
|
+
const declaredKeys = /* @__PURE__ */ new Set();
|
|
5014
|
+
for (const [vendor, declared] of Object.entries(((_d = manifest.provider) == null ? void 0 : _d.vendors) || {})) {
|
|
5015
|
+
if (!(declared == null ? void 0 : declared.name)) throw new Error(manifest.slug + " declares vendor " + vendor + " with no name");
|
|
5016
|
+
checkIcon(manifest.slug + " vendor " + vendor, declared.icon);
|
|
5017
|
+
if (!Array.isArray(declared.fields) || !declared.fields.length) {
|
|
5018
|
+
throw new Error(manifest.slug + " declares vendor " + vendor + " with no fields \u2014 a vendor nothing is typed into holds nothing");
|
|
4921
5019
|
}
|
|
4922
|
-
|
|
4923
|
-
|
|
5020
|
+
for (const field2 of declared.fields) {
|
|
5021
|
+
if (!(field2 == null ? void 0 : field2.key) || !(field2 == null ? void 0 : field2.label)) {
|
|
5022
|
+
throw new Error(manifest.slug + " declares a provider field with no key or label");
|
|
5023
|
+
}
|
|
5024
|
+
if (!INPUTS.includes(field2.input)) {
|
|
5025
|
+
throw new Error(manifest.slug + ".provider." + field2.key + " needs an input the admin form can render \u2014 one of " + INPUTS.join(", "));
|
|
5026
|
+
}
|
|
5027
|
+
if (field2.input === "password" && !field2.redact) {
|
|
5028
|
+
throw new Error(manifest.slug + ".provider." + field2.key + " is a password and must declare redact : true \u2014 the api would hand the value back");
|
|
5029
|
+
}
|
|
5030
|
+
if (declaredKeys.has(field2.key)) {
|
|
5031
|
+
throw new Error(manifest.slug + " declares " + field2.key + " under two vendors \u2014 vendorSettings() merges them and one would win");
|
|
5032
|
+
}
|
|
5033
|
+
declaredKeys.add(field2.key);
|
|
4924
5034
|
}
|
|
4925
5035
|
}
|
|
4926
|
-
|
|
4927
|
-
throw new Error(manifest.slug + " needs an icon \u2014 the svg markup itself, not a path to one");
|
|
4928
|
-
}
|
|
4929
|
-
if (!manifest.icon.includes("viewBox")) {
|
|
4930
|
-
throw new Error(manifest.slug + " icon has no viewBox, so it cannot scale");
|
|
4931
|
-
}
|
|
4932
|
-
if (manifest.icon.includes("<image")) {
|
|
4933
|
-
throw new Error(manifest.slug + " icon wraps a raster \u2014 re-export it as vector shapes");
|
|
4934
|
-
}
|
|
5036
|
+
checkIcon(manifest.slug, manifest == null ? void 0 : manifest.icon);
|
|
4935
5037
|
if (!GROUPS.includes(manifest == null ? void 0 : manifest.group)) {
|
|
4936
5038
|
throw new Error(manifest.slug + " needs a group \u2014 one of " + GROUPS.join(", "));
|
|
4937
5039
|
}
|
|
4938
|
-
if ((
|
|
5040
|
+
if ((_e = manifest == null ? void 0 : manifest.connect) == null ? void 0 : _e.type) {
|
|
4939
5041
|
throw new Error(manifest.slug + " declares connect.type \u2014 that is auth.type now");
|
|
4940
5042
|
}
|
|
4941
|
-
if (!AUTH_TYPES.includes((
|
|
5043
|
+
if (!AUTH_TYPES.includes((_f = manifest == null ? void 0 : manifest.auth) == null ? void 0 : _f.type)) {
|
|
4942
5044
|
throw new Error(manifest.slug + " needs auth.type \u2014 one of " + AUTH_TYPES.join(", "));
|
|
4943
5045
|
}
|
|
4944
5046
|
if (manifest.auth.type === "oauth") {
|
|
4945
5047
|
for (const field2 of OAUTH_FIELDS) {
|
|
4946
|
-
if (!((
|
|
5048
|
+
if (!((_g = manifest.auth.oauth) == null ? void 0 : _g[field2])) {
|
|
4947
5049
|
throw new Error(manifest.slug + " is oauth and must declare auth.oauth." + field2);
|
|
4948
5050
|
}
|
|
4949
5051
|
}
|
|
4950
|
-
if (typeof ((
|
|
5052
|
+
if (typeof ((_i = (_h = manifest.hooks) == null ? void 0 : _h.auth) == null ? void 0 : _i.token) !== "function") {
|
|
4951
5053
|
throw new Error(manifest.slug + " is oauth and must implement hooks.auth.token \u2014 point it at authToken() or wrap it");
|
|
4952
5054
|
}
|
|
4953
5055
|
for (const url of OAUTH_URLS) {
|
|
4954
|
-
if (!((
|
|
5056
|
+
if (!((_k = (_j = manifest.auth.oauth) == null ? void 0 : _j.urls) == null ? void 0 : _k[url])) {
|
|
4955
5057
|
throw new Error(manifest.slug + " is oauth and must declare auth.oauth.urls." + url);
|
|
4956
5058
|
}
|
|
4957
5059
|
}
|
|
@@ -4961,16 +5063,16 @@ var build = (manifest) => {
|
|
|
4961
5063
|
);
|
|
4962
5064
|
}
|
|
4963
5065
|
}
|
|
4964
|
-
if (implemented(manifest.hooks, "inbound.event") && typeof ((
|
|
5066
|
+
if (implemented(manifest.hooks, "inbound.event") && typeof ((_m = (_l = manifest.hooks) == null ? void 0 : _l.inbound) == null ? void 0 : _m.event) !== "function" && !((_o = (_n = manifest.inbound) == null ? void 0 : _n.headers) == null ? void 0 : _o.event)) {
|
|
4965
5067
|
throw new Error(manifest.slug + " implements inbound.event but declares no inbound.headers.event");
|
|
4966
5068
|
}
|
|
4967
|
-
if (implemented(manifest.hooks, "inbound.verify") && !((
|
|
5069
|
+
if (implemented(manifest.hooks, "inbound.verify") && !((_q = (_p = manifest.inbound) == null ? void 0 : _p.headers) == null ? void 0 : _q.signature)) {
|
|
4968
5070
|
throw new Error(manifest.slug + " implements inbound.verify but declares no inbound.headers.signature");
|
|
4969
5071
|
}
|
|
4970
5072
|
if (typeof (manifest == null ? void 0 : manifest.status) !== "function") {
|
|
4971
5073
|
throw new Error(manifest.slug + " must declare status( data ) \u2014 return null to accept the connection's own status, or { message, status } to override it");
|
|
4972
5074
|
}
|
|
4973
|
-
if (!Array.isArray((
|
|
5075
|
+
if (!Array.isArray((_r = manifest == null ? void 0 : manifest.content) == null ? void 0 : _r.guide) || !manifest.content.guide.length) {
|
|
4974
5076
|
throw new Error(manifest.slug + " needs content.guide \u2014 an array of steps for its page");
|
|
4975
5077
|
}
|
|
4976
5078
|
if (typeof (manifest == null ? void 0 : manifest.status) !== "function") {
|
|
@@ -4982,8 +5084,8 @@ var build = (manifest) => {
|
|
|
4982
5084
|
}
|
|
4983
5085
|
for (const [domain, verbs] of Object.entries(HOOKS)) {
|
|
4984
5086
|
for (const verb of verbs) {
|
|
4985
|
-
const hook = (
|
|
4986
|
-
if (((
|
|
5087
|
+
const hook = (_t = (_s = manifest.hooks) == null ? void 0 : _s[domain]) == null ? void 0 : _t[verb];
|
|
5088
|
+
if (((_u = manifest.hooks) == null ? void 0 : _u[domain]) === false) continue;
|
|
4987
5089
|
if (hook !== false && !implemented({ [domain]: { [verb]: hook } }, domain + "." + verb)) {
|
|
4988
5090
|
throw new Error(manifest.slug + " must answer hooks." + domain + "." + verb + " \u2014 false, a function, or {} if another repo implements it");
|
|
4989
5091
|
}
|
|
@@ -5028,6 +5130,44 @@ var connections = Object.freeze({
|
|
|
5028
5130
|
shopify: build(shopify_default2),
|
|
5029
5131
|
webhook: build(webhook_default)
|
|
5030
5132
|
});
|
|
5133
|
+
var canonical = (field2) => JSON.stringify(Object.fromEntries(Object.entries(field2).sort()));
|
|
5134
|
+
var mergeVendors = (catalog) => {
|
|
5135
|
+
var _a;
|
|
5136
|
+
const merged = {};
|
|
5137
|
+
const claimed = /* @__PURE__ */ new Map();
|
|
5138
|
+
for (const [slug2, manifest] of Object.entries(catalog)) {
|
|
5139
|
+
for (const [vendor, declared] of Object.entries(((_a = manifest.provider) == null ? void 0 : _a.vendors) || {})) {
|
|
5140
|
+
const held = merged[vendor] || (merged[vendor] = { fields: [], icon: declared.icon, name: declared.name });
|
|
5141
|
+
if (held.name !== declared.name) {
|
|
5142
|
+
throw new Error(slug2 + " names vendor " + vendor + ' "' + declared.name + '" but another manifest names it "' + held.name + '"');
|
|
5143
|
+
}
|
|
5144
|
+
if (held.icon !== declared.icon) {
|
|
5145
|
+
throw new Error(slug2 + " declares a different icon for vendor " + vendor + " than another manifest \u2014 one vendor, one mark");
|
|
5146
|
+
}
|
|
5147
|
+
for (const field2 of declared.fields) {
|
|
5148
|
+
const existing = held.fields.find((entry) => entry.key === field2.key);
|
|
5149
|
+
if (existing) {
|
|
5150
|
+
if (canonical(existing) !== canonical(field2)) {
|
|
5151
|
+
throw new Error(slug2 + " declares " + vendor + "." + field2.key + " differently from another manifest \u2014 a field two connections spend is declared identically in both");
|
|
5152
|
+
}
|
|
5153
|
+
continue;
|
|
5154
|
+
}
|
|
5155
|
+
if (field2.credential) {
|
|
5156
|
+
const owner = claimed.get(field2.credential);
|
|
5157
|
+
if (owner) {
|
|
5158
|
+
throw new Error(field2.credential + " is claimed by both " + owner + " and " + vendor + "." + field2.key + " \u2014 one would silently overwrite the other");
|
|
5159
|
+
}
|
|
5160
|
+
claimed.set(field2.credential, vendor + "." + field2.key);
|
|
5161
|
+
}
|
|
5162
|
+
held.fields.push(field2);
|
|
5163
|
+
}
|
|
5164
|
+
}
|
|
5165
|
+
}
|
|
5166
|
+
return Object.freeze(Object.fromEntries(
|
|
5167
|
+
Object.entries(merged).map(([vendor, held]) => [vendor, Object.freeze({ ...held, fields: Object.freeze(held.fields) })])
|
|
5168
|
+
));
|
|
5169
|
+
};
|
|
5170
|
+
var vendors = mergeVendors(connections);
|
|
5031
5171
|
(() => {
|
|
5032
5172
|
var _a;
|
|
5033
5173
|
const routes = {};
|
|
@@ -5100,11 +5240,8 @@ var publicConnectionKeys = Object.freeze([
|
|
|
5100
5240
|
]);
|
|
5101
5241
|
|
|
5102
5242
|
// lib/providers.js
|
|
5103
|
-
var providerFields = (slug2) =>
|
|
5104
|
-
|
|
5105
|
-
return Object.hasOwn(connections, slug2) ? ((_a = connections[slug2].provider) == null ? void 0 : _a.fields) || [] : [];
|
|
5106
|
-
};
|
|
5107
|
-
var providerSlugs = () => Object.keys(connections).filter((slug2) => connections[slug2].provider).sort();
|
|
5243
|
+
var providerFields = (slug2) => Object.hasOwn(vendors, slug2) ? vendors[slug2].fields : [];
|
|
5244
|
+
var providerSlugs = () => Object.keys(vendors).sort();
|
|
5108
5245
|
var isLive = (slug2, settings) => {
|
|
5109
5246
|
const fields2 = providerFields(slug2);
|
|
5110
5247
|
if (!fields2.length) return false;
|
|
@@ -5129,6 +5266,15 @@ var providerSettings = async ({ controller, slug: slug2 }) => {
|
|
|
5129
5266
|
providerMemo.set(slug2, { at: Date.now(), value });
|
|
5130
5267
|
return value;
|
|
5131
5268
|
};
|
|
5269
|
+
var vendorSettings = async ({ controller, slug: slug2 }) => {
|
|
5270
|
+
var _a;
|
|
5271
|
+
const declared = Object.hasOwn(connections, slug2) ? Object.keys(((_a = connections[slug2].provider) == null ? void 0 : _a.vendors) || {}) : [];
|
|
5272
|
+
let merged = {};
|
|
5273
|
+
for (const vendor of declared) {
|
|
5274
|
+
merged = { ...merged, ...await providerSettings({ controller, slug: vendor }) };
|
|
5275
|
+
}
|
|
5276
|
+
return merged;
|
|
5277
|
+
};
|
|
5132
5278
|
var saveProviderSettings = async ({ authenticated, clear, controller, settings, slug: slug2 }) => {
|
|
5133
5279
|
const fields2 = providerFields(slug2);
|
|
5134
5280
|
if (!fields2.length) return null;
|
|
@@ -5190,5 +5336,7 @@ export {
|
|
|
5190
5336
|
providerMemo,
|
|
5191
5337
|
providerSettings,
|
|
5192
5338
|
providerSlugs,
|
|
5193
|
-
saveProviderSettings
|
|
5339
|
+
saveProviderSettings,
|
|
5340
|
+
vendorSettings,
|
|
5341
|
+
vendors
|
|
5194
5342
|
};
|
package/package.json
CHANGED