@cosmoops/connect-sdk 0.34.1 → 0.35.0
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/CHANGELOG.md +98 -0
- package/dist/cjs/cli/doctor.js +39 -5
- package/dist/cjs/client/components/shell-context.js +35 -6
- package/dist/cjs/client/components/sidebar.js +6 -1
- package/dist/cjs/next/index.js +56 -1
- package/dist/cjs/server/client.js +1 -1
- package/dist/esm/cli/doctor.js +38 -5
- package/dist/esm/client/components/shell-context.js +35 -6
- package/dist/esm/client/components/sidebar.js +6 -1
- package/dist/esm/next/index.js +56 -2
- package/dist/esm/server/client.js +1 -1
- package/dist/types/client/components/shell-context.d.ts +39 -7
- package/dist/types/client/components/sidebar.d.ts +2 -2
- package/dist/types/next/index.d.ts +49 -0
- package/dist/types/server/client.d.ts +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,104 @@
|
|
|
3
3
|
`@cosmoops/connect-sdk` follows semver, with the 0.x convention that **minor
|
|
4
4
|
versions may carry breaking changes** and patch versions never do.
|
|
5
5
|
|
|
6
|
+
## 0.35.0
|
|
7
|
+
|
|
8
|
+
One addition, `connectProviderProps()`, for a mistake both applications built
|
|
9
|
+
on this SDK shipped before anyone noticed.
|
|
10
|
+
|
|
11
|
+
### Your server and your browser can address different Connect instances
|
|
12
|
+
|
|
13
|
+
`CONNECT_APP_URL` points the server at a non-production Connect. It is not
|
|
14
|
+
`NEXT_PUBLIC_`, so it never reaches the browser, and `ConnectProvider` defaults
|
|
15
|
+
`appUrl` to the public instance independently. Point one and not the other and
|
|
16
|
+
nothing fails: your API reads go to staging while every destination the browser
|
|
17
|
+
builds opens **production** - the user menu's Profile and Billing rows, the app
|
|
18
|
+
launcher's link for an unsubscribed application, `ConnectAccessGate`'s subscribe
|
|
19
|
+
target, and checkout.
|
|
20
|
+
|
|
21
|
+
The docs said to pass both. That was a rule to remember rather than a shape to
|
|
22
|
+
follow, and the sentence next to it - "the provider takes no props, which is the
|
|
23
|
+
point" - was about `clientId` and read as being about all of them.
|
|
24
|
+
|
|
25
|
+
```tsx title="app/layout.tsx"
|
|
26
|
+
import { connectProviderProps } from "@cosmoops/connect-sdk/next";
|
|
27
|
+
import { ConnectProvider } from "@cosmoops/connect-sdk/client";
|
|
28
|
+
|
|
29
|
+
<ConnectProvider {...connectProviderProps()}>{children}</ConnectProvider>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
It returns `{ appUrl }`, resolved from `CONNECT_APP_URL` and falling back to the
|
|
33
|
+
production origin - so the line is correct in every environment and you write it
|
|
34
|
+
once. Props you pass yourself still win, as long as the spread comes first.
|
|
35
|
+
|
|
36
|
+
**Call it in the Server Component, not in your shell.** It reads a server-side
|
|
37
|
+
variable, so it ships from `/next`, which a Client Component cannot import -
|
|
38
|
+
attempting it fails the build naming `this-entry-is-server-only`. A shell that
|
|
39
|
+
needs `usePathname()` takes the result as a prop; `{ appUrl }` is a plain
|
|
40
|
+
serializable object, so that costs nothing.
|
|
41
|
+
|
|
42
|
+
Already have a helper that owns this origin - because you also build your own
|
|
43
|
+
links into Connect - keep using it. One function owning the read beats this one
|
|
44
|
+
sitting beside it.
|
|
45
|
+
|
|
46
|
+
Nothing changes if you were already passing `appUrl`, and nothing breaks if you
|
|
47
|
+
were not: the default is unchanged.
|
|
48
|
+
|
|
49
|
+
**This was never a security issue**, which is worth saying because it sounds
|
|
50
|
+
like one. `appUrl` is a navigation target you set from your own environment: it
|
|
51
|
+
carries no credential, no gate or permission check reads it, it is never
|
|
52
|
+
reachable from a URL or a request body, and redirect URIs are still matched
|
|
53
|
+
exactly server-side. The worst case is a real charge in the wrong instance, not
|
|
54
|
+
a way in.
|
|
55
|
+
|
|
56
|
+
### The sidebar's nav rows are 36px, so a ten-route rail stops scrolling
|
|
57
|
+
|
|
58
|
+
`AppShell`'s rail is the only part of the shell that grows with *your* route
|
|
59
|
+
count, and `ConnectSidebarBody` is the only part that scrolls - so a rail that
|
|
60
|
+
overflows overflows there. Ten destinations at the old 40px came to 436px of
|
|
61
|
+
nav against 273px of fixed chrome (header, workspace switcher, secondary-nav
|
|
62
|
+
footer, account footer), which needs a 709px viewport to sit still; a 1366x768
|
|
63
|
+
screen has about 678px of it. The nav scrolled under its own footer on the most
|
|
64
|
+
common small laptop, which reads as a rail with destinations missing from it.
|
|
65
|
+
|
|
66
|
+
Nav rows - and every 20px-glyph row, so the secondary nav and the app launcher
|
|
67
|
+
too - are now **36px**, and the scrolling region's own vertical padding drops
|
|
68
|
+
from 8px to 4px a side. That is 56px back on a twelve-row integration, enough
|
|
69
|
+
that the same rail sits still. 36px is still past WCAG 2.5.8's 24px target
|
|
70
|
+
minimum, with the row's full width as the hit area.
|
|
71
|
+
|
|
72
|
+
**The two 32px-glyph rows stay at 40px** - the workspace switcher and the
|
|
73
|
+
account row. There are exactly two of them, neither scales with your nav, and
|
|
74
|
+
both need the height: a 32px avatar in a 36px row has 2px of air, and the
|
|
75
|
+
account row's label is two lines.
|
|
76
|
+
|
|
77
|
+
**Shrinking the icons would not have done it.** The glyph box is a flex
|
|
78
|
+
centring container for an icon *you* supply at your own size, so a smaller box
|
|
79
|
+
buys no vertical space and only pushes the icon off the 32px horizontal centre
|
|
80
|
+
the collapsed rail is built on - `RAIL_GUTTER + inset + glyph/2 = RAIL_COLLAPSED / 2`
|
|
81
|
+
is what lets the rail collapse without anything drifting sideways.
|
|
82
|
+
|
|
83
|
+
Nothing in your code changes. If your nav is long enough to still overflow, the
|
|
84
|
+
levers are the row count and `secondaryNav` - a rail is navigation, and past a
|
|
85
|
+
dozen rows a scrolling one is a sitemap.
|
|
86
|
+
|
|
87
|
+
### `doctor` now catches it
|
|
88
|
+
|
|
89
|
+
`npx @cosmoops/connect-sdk doctor` reports a **note** when `CONNECT_APP_URL` is
|
|
90
|
+
set and the layout holding `<ConnectProvider>` passes no `appUrl`, with the fix
|
|
91
|
+
in the output. A note rather than a failure, so it cannot break a CI run: the
|
|
92
|
+
prop may be threaded from the layout into a `"use client"` shell, which reading
|
|
93
|
+
the layout cannot see.
|
|
94
|
+
|
|
95
|
+
### Fixed: the User-Agent reported the wrong version
|
|
96
|
+
|
|
97
|
+
`SDK_VERSION` was left at `0.34.0` when 0.34.1 shipped, so every request this
|
|
98
|
+
package made identified itself as the previous release. It is in step again, and
|
|
99
|
+
the assertion that pins it to `package.json` is back to green - it had been
|
|
100
|
+
failing since that release, unnoticed because the publish guard runs the build
|
|
101
|
+
and the pack check rather than the test suite. Diagnostic only; nothing behaved
|
|
102
|
+
differently.
|
|
103
|
+
|
|
6
104
|
## 0.34.1
|
|
7
105
|
|
|
8
106
|
Two tabs, or one abandoned sign-in and one fresh one, could not both work -
|
package/dist/cjs/cli/doctor.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
"use client";
|
|
1
2
|
"use strict";
|
|
2
3
|
/**
|
|
3
4
|
* `npx @cosmoops/connect-sdk doctor` - checks a wired-up project for the
|
|
@@ -84,14 +85,14 @@ function checkBridge(appDir, root) {
|
|
|
84
85
|
}
|
|
85
86
|
return { status: "pass", title: `Bridge route handler (${(0, node_path_1.relative)(root, bridge)})` };
|
|
86
87
|
}
|
|
87
|
-
function checkProvider(appDir, root) {
|
|
88
|
+
function checkProvider(appDir, root, env) {
|
|
88
89
|
const layouts = walk(appDir, ["layout.tsx", "layout.jsx"]);
|
|
89
90
|
const hosting = layouts.filter((path) => /<ConnectProvider/.test(read(path)));
|
|
90
91
|
if (hosting.length === 0) {
|
|
91
92
|
return {
|
|
92
93
|
status: "fail",
|
|
93
94
|
title: "ConnectProvider in a layout",
|
|
94
|
-
detail: 'Nothing renders <ConnectProvider>. Every client hook and component below it throws without one. In app/layout.tsx:\n import { ConnectProvider } from "@cosmoops/connect-sdk/client";\n <ConnectProvider>{children}</ConnectProvider>',
|
|
95
|
+
detail: 'Nothing renders <ConnectProvider>. Every client hook and component below it throws without one. In app/layout.tsx:\n import { connectProviderProps } from "@cosmoops/connect-sdk/next";\n import { ConnectProvider } from "@cosmoops/connect-sdk/client";\n <ConnectProvider {...connectProviderProps()}>{children}</ConnectProvider>',
|
|
95
96
|
};
|
|
96
97
|
}
|
|
97
98
|
// A nested provider re-fetches the session and keeps a second cache that the
|
|
@@ -104,8 +105,42 @@ function checkProvider(appDir, root) {
|
|
|
104
105
|
detail: `Found in ${hosting.length} layouts (${hosting.map((path) => (0, node_path_1.relative)(root, path)).join(", ")}). Nested providers keep separate caches, so a mutation in one is invisible to the other. Keep the outermost one only.`,
|
|
105
106
|
};
|
|
106
107
|
}
|
|
108
|
+
/*
|
|
109
|
+
* The split integration, and the reason this check exists at all.
|
|
110
|
+
*
|
|
111
|
+
* `CONNECT_APP_URL` points the *server* at a non-production Connect. It is
|
|
112
|
+
* not `NEXT_PUBLIC_`, so `ConnectProvider` cannot read it and defaults
|
|
113
|
+
* `appUrl` to production independently - and nothing fails. The API reads go
|
|
114
|
+
* to the configured instance while every destination the browser builds
|
|
115
|
+
* opens production: the user menu's Profile and Billing rows, the launcher's
|
|
116
|
+
* link for an unsubscribed application, the access gate's subscribe target,
|
|
117
|
+
* and checkout. Both applications built on this SDK shipped exactly that.
|
|
118
|
+
*
|
|
119
|
+
* `warn` rather than `fail`: the prop may be threaded from a parent Server
|
|
120
|
+
* Component into a `"use client"` shell, which is the documented shape for a
|
|
121
|
+
* shell needing `usePathname()` - and that assignment is not visible in the
|
|
122
|
+
* layout this reads. So this cannot tell from the outside, which is what
|
|
123
|
+
* `warn` means here.
|
|
124
|
+
*/
|
|
125
|
+
const pointedElsewhere = /^[ \t]*CONNECT_APP_URL[ \t]*=[ \t]*\S/m.test(env);
|
|
126
|
+
const carriesOrigin = /appUrl|connectProviderProps/.test(read(hosting[0]));
|
|
127
|
+
if (pointedElsewhere && !carriesOrigin) {
|
|
128
|
+
return {
|
|
129
|
+
status: "warn",
|
|
130
|
+
title: "ConnectProvider in a layout",
|
|
131
|
+
detail: `CONNECT_APP_URL is set, but ${(0, node_path_1.relative)(root, hosting[0])} passes no appUrl - so your server talks to that instance while every link the browser builds opens production Connect. Spread it in:\n <ConnectProvider {...connectProviderProps()}> // from "@cosmoops/connect-sdk/next"\n Already threading it into a "use client" shell? Then this is fine and you can ignore it.`,
|
|
132
|
+
};
|
|
133
|
+
}
|
|
107
134
|
return { status: "pass", title: `ConnectProvider in a layout (${(0, node_path_1.relative)(root, hosting[0])})` };
|
|
108
135
|
}
|
|
136
|
+
/** The env files `checkEnv` reads, as one string, shared with `checkProvider`. */
|
|
137
|
+
function envText(root) {
|
|
138
|
+
return [".env.local", ".env.development.local", ".env"]
|
|
139
|
+
.map((name) => (0, node_path_1.join)(root, name))
|
|
140
|
+
.filter(node_fs_1.existsSync)
|
|
141
|
+
.map(read)
|
|
142
|
+
.join("\n");
|
|
143
|
+
}
|
|
109
144
|
/**
|
|
110
145
|
* Order is the whole check.
|
|
111
146
|
*
|
|
@@ -146,8 +181,7 @@ function checkTheme(root) {
|
|
|
146
181
|
* loaded it - exactly the shell `next dev` will inherit.
|
|
147
182
|
*/
|
|
148
183
|
function checkEnv(root) {
|
|
149
|
-
const
|
|
150
|
-
const combined = files.filter(node_fs_1.existsSync).map(read).join("\n");
|
|
184
|
+
const combined = envText(root);
|
|
151
185
|
return ["CONNECT_API_KEY", "CONNECT_CLIENT_ID"].map((name) => {
|
|
152
186
|
// Horizontal whitespace only. `\s*` also matches the newline, so a bare
|
|
153
187
|
// `CONNECT_API_KEY=` was satisfied by the *next* line's value and an empty
|
|
@@ -191,7 +225,7 @@ function runDoctor(argv = []) {
|
|
|
191
225
|
console.log(`[connect-sdk] Checking ${(0, node_path_1.relative)(process.cwd(), root) || root}\n`);
|
|
192
226
|
const checks = [
|
|
193
227
|
checkBridge(appDir, root),
|
|
194
|
-
checkProvider(appDir, root),
|
|
228
|
+
checkProvider(appDir, root, envText(root)),
|
|
195
229
|
checkTheme(root),
|
|
196
230
|
...checkEnv(root),
|
|
197
231
|
checkRedirectUri(),
|
|
@@ -36,22 +36,51 @@ exports.RAIL_GUTTER = 12;
|
|
|
36
36
|
* The row shape every sidebar control shares - nav items, the workspace tile,
|
|
37
37
|
* the launcher, the user button.
|
|
38
38
|
*
|
|
39
|
+
* **The height is not here.** It rides on `SIDEBAR_ROW_ICON` /
|
|
40
|
+
* `SIDEBAR_ROW_TILE` instead, because the two glyph sizes want different
|
|
41
|
+
* heights and only one of them is in the region that overflows - see those
|
|
42
|
+
* two constants.
|
|
43
|
+
*
|
|
39
44
|
* `overflow-hidden` + `whitespace-nowrap` is what makes the collapse smooth:
|
|
40
45
|
* the label is *clipped* by the shrinking rail rather than re-wrapped or
|
|
41
46
|
* re-measured, so a width animation costs no reflow. Fading the label with
|
|
42
47
|
* `SidebarLabel` on top of that hides the clip itself.
|
|
43
48
|
*/
|
|
44
|
-
exports.SIDEBAR_ROW = "group/row relative flex
|
|
49
|
+
exports.SIDEBAR_ROW = "group/row relative flex w-full shrink-0 items-center justify-start gap-3 overflow-hidden whitespace-nowrap rounded-lg pe-2 text-sm font-normal transition-colors focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-focus";
|
|
45
50
|
/**
|
|
46
|
-
* Leading inset for a row whose glyph is 20px wide (a nav icon,
|
|
51
|
+
* Leading inset *and height* for a row whose glyph is 20px wide (a nav icon,
|
|
52
|
+
* the launcher, a secondary-nav row).
|
|
53
|
+
*
|
|
47
54
|
* `10 + 10 = 20`, and `RAIL_GUTTER + 20 = 32`. See `RAIL_COLLAPSED`.
|
|
55
|
+
*
|
|
56
|
+
* **36px, not 40px, and the height belongs on this axis rather than on
|
|
57
|
+
* `SIDEBAR_ROW`.** The nav is the only region of the rail that grows with the
|
|
58
|
+
* host's route count, and `ConnectSidebarBody` is the only region that
|
|
59
|
+
* scrolls - so a rail that overflows overflows here. Ten destinations at 40px
|
|
60
|
+
* came to 436px of nav against 273px of fixed chrome (header, switcher, two
|
|
61
|
+
* footers), which needs a 709px viewport to sit still; a 1366x768 screen has
|
|
62
|
+
* about 678px of it. Four pixels a row is 48px back across the twelve rows a
|
|
63
|
+
* real integration draws, and 36px is still comfortably past the 24px
|
|
64
|
+
* WCAG 2.5.8 target minimum with the row's full width as the hit area.
|
|
65
|
+
*
|
|
66
|
+
* It is deliberately *not* a smaller glyph. The 20px box is a flex centring
|
|
67
|
+
* container for an icon the **host** supplies at its own size, so shrinking
|
|
68
|
+
* the box buys no vertical space and only pushes the icon off the 32px centre
|
|
69
|
+
* the collapsed rail is built on.
|
|
48
70
|
*/
|
|
49
|
-
exports.SIDEBAR_ROW_ICON = "ps-[10px]";
|
|
71
|
+
exports.SIDEBAR_ROW_ICON = "h-9 ps-[10px]";
|
|
50
72
|
/**
|
|
51
|
-
* Leading inset for a row whose glyph is 32px wide (the avatar, the
|
|
52
|
-
* tile). `4 + 16 = 20`, landing on the same 32px centre as
|
|
73
|
+
* Leading inset and height for a row whose glyph is 32px wide (the avatar, the
|
|
74
|
+
* workspace tile). `4 + 16 = 20`, landing on the same 32px centre as
|
|
75
|
+
* `SIDEBAR_ROW_ICON`.
|
|
76
|
+
*
|
|
77
|
+
* **These stay at 40px.** There are exactly two of them and neither scales
|
|
78
|
+
* with the host's nav, so they are not what overflows - and both need the
|
|
79
|
+
* height: a 32px tile in a 36px row has 2px of air, and the account row's
|
|
80
|
+
* label is two lines (name over email, `leading-tight`) which measures ~32px
|
|
81
|
+
* on its own.
|
|
53
82
|
*/
|
|
54
|
-
exports.SIDEBAR_ROW_TILE = "ps-[4px]";
|
|
83
|
+
exports.SIDEBAR_ROW_TILE = "h-10 ps-[4px]";
|
|
55
84
|
/**
|
|
56
85
|
* The class list for one sidebar row, in one place.
|
|
57
86
|
*
|
|
@@ -116,7 +116,12 @@ function ConnectSidebarBody({ children }) {
|
|
|
116
116
|
// zoom away over a region of text is a WCAG 1.4.4 failure, and nothing
|
|
117
117
|
// here needs it suppressed. On the desktop rail, where no ancestor
|
|
118
118
|
// restricts anything, the pair is equivalent to the default.
|
|
119
|
-
|
|
119
|
+
// `py-1` rather than the `py-2` every other region carries: this is the
|
|
120
|
+
// one region that scrolls, so it is the first place to give up air when
|
|
121
|
+
// the nav is a row or two from overflowing. The rows paint their own
|
|
122
|
+
// rounded background, so the hairline above the footer is still clear of
|
|
123
|
+
// them. See `SIDEBAR_ROW_ICON` for the arithmetic this is part of.
|
|
124
|
+
(0, jsx_runtime_1.jsx)("div", { className: "flex min-h-0 flex-1 touch-pan-y touch-pinch-zoom flex-col gap-1 overflow-y-auto overflow-x-hidden px-3 py-1", children: children }));
|
|
120
125
|
}
|
|
121
126
|
/**
|
|
122
127
|
* A pinned region at the foot of the rail - the secondary nav, the launcher,
|
package/dist/cjs/next/index.js
CHANGED
|
@@ -36,6 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
37
|
exports.ConnectClient = exports.createConnectHandler = void 0;
|
|
38
38
|
exports.connectClient = connectClient;
|
|
39
|
+
exports.connectProviderProps = connectProviderProps;
|
|
39
40
|
exports.cookieSessionStore = cookieSessionStore;
|
|
40
41
|
exports.createConnectHandlers = createConnectHandlers;
|
|
41
42
|
exports.GET = handle;
|
|
@@ -68,8 +69,9 @@ const errors_js_1 = require("../errors.js");
|
|
|
68
69
|
*
|
|
69
70
|
* ```tsx
|
|
70
71
|
* // app/layout.tsx
|
|
72
|
+
* import { connectProviderProps } from "@cosmoops/connect-sdk/next";
|
|
71
73
|
* import { ConnectProvider } from "@cosmoops/connect-sdk/client";
|
|
72
|
-
* <ConnectProvider>{children}</ConnectProvider>
|
|
74
|
+
* <ConnectProvider {...connectProviderProps()}>{children}</ConnectProvider>
|
|
73
75
|
* ```
|
|
74
76
|
*
|
|
75
77
|
* No `next.config.ts` changes needed - configuration comes from the
|
|
@@ -86,6 +88,10 @@ const errors_js_1 = require("../errors.js");
|
|
|
86
88
|
* `ConnectProvider` defaults `appUrl` to the production origin independently,
|
|
87
89
|
* so an app pointed at another instance must pass that prop as well or its
|
|
88
90
|
* portal links and its browser-built authorize URL still go to production.
|
|
91
|
+
* That is what the `connectProviderProps()` spread above is for, and why the
|
|
92
|
+
* layout is two imports rather than one - leave it off and the server half and
|
|
93
|
+
* the browser half of the same integration address different instances, with
|
|
94
|
+
* nothing failing to say so. See that function's own docs.
|
|
89
95
|
*
|
|
90
96
|
* Register `{your origin}/api/connect/callback` as a redirect URI in the
|
|
91
97
|
* application's Connect client section. That is the only step this cannot do
|
|
@@ -126,6 +132,55 @@ function connectClient(overrides = {}) {
|
|
|
126
132
|
cached = client;
|
|
127
133
|
return client;
|
|
128
134
|
}
|
|
135
|
+
/**
|
|
136
|
+
* The `ConnectProvider` props that come from the environment.
|
|
137
|
+
*
|
|
138
|
+
* ```tsx
|
|
139
|
+
* // app/layout.tsx - a Server Component
|
|
140
|
+
* import { connectProviderProps } from "@cosmoops/connect-sdk/next";
|
|
141
|
+
* import { ConnectProvider } from "@cosmoops/connect-sdk/client";
|
|
142
|
+
*
|
|
143
|
+
* <ConnectProvider {...connectProviderProps()}>{children}</ConnectProvider>
|
|
144
|
+
* ```
|
|
145
|
+
*
|
|
146
|
+
* ## What it is for
|
|
147
|
+
*
|
|
148
|
+
* `CONNECT_APP_URL` points the *server* at a non-production Connect. It is not
|
|
149
|
+
* `NEXT_PUBLIC_`, so it never reaches the browser, and `ConnectProvider`
|
|
150
|
+
* defaults `appUrl` to the production origin independently - so pointing the
|
|
151
|
+
* server somewhere else and leaving the prop off splits the integration in
|
|
152
|
+
* half. The server talks to dev and every destination the browser builds opens
|
|
153
|
+
* production: the user menu's Profile and Billing rows, the app launcher's link
|
|
154
|
+
* for an unsubscribed application, `ConnectAccessGate`'s subscribe target, and
|
|
155
|
+
* checkout. Nothing errors. The customer is simply asked to buy a second
|
|
156
|
+
* subscription in an instance where they have none.
|
|
157
|
+
*
|
|
158
|
+
* Both apps built on this SDK shipped that bug before anyone noticed, from
|
|
159
|
+
* reading "the provider takes no props" as a rule rather than as a remark about
|
|
160
|
+
* `clientId`. A root layout is a Server Component, so one spread fixes it with
|
|
161
|
+
* no browser-visible copy of the variable.
|
|
162
|
+
*
|
|
163
|
+
* ## What it deliberately leaves out
|
|
164
|
+
*
|
|
165
|
+
* `clientId` and `basePath`. The first is only needed alongside an explicit
|
|
166
|
+
* `redirectUri`, when you build the authorize URL in the browser rather than
|
|
167
|
+
* letting `signIn()` bounce through your own `/signin` route - and handing the
|
|
168
|
+
* browser a value it does not need is surface for nothing. The second is where
|
|
169
|
+
* *you* mounted the handler, which the environment does not know. Pass either
|
|
170
|
+
* yourself; a prop you pass always wins over this spread, whichever order you
|
|
171
|
+
* write them in, as long as the spread comes first.
|
|
172
|
+
*
|
|
173
|
+
* ## If you already have an origin helper
|
|
174
|
+
*
|
|
175
|
+
* Use it instead. An app that builds its own links into Connect (a "Manage
|
|
176
|
+
* team" button, a pricing page's subscribe target) needs that origin on the
|
|
177
|
+
* server too, and one function owning the read is better than this helper
|
|
178
|
+
* beside it - two readers of one variable is the shape that caused this. This
|
|
179
|
+
* exists for the integration that has no such helper, which is most of them.
|
|
180
|
+
*/
|
|
181
|
+
function connectProviderProps() {
|
|
182
|
+
return { appUrl: (process.env.CONNECT_APP_URL ?? client_js_1.DEFAULT_BASE_URL).replace(/\/+$/, "") };
|
|
183
|
+
}
|
|
129
184
|
/**
|
|
130
185
|
* An httpOnly cookie holding the opaque `sessionToken`.
|
|
131
186
|
*
|
package/dist/esm/cli/doctor.js
CHANGED
|
@@ -81,14 +81,14 @@ function checkBridge(appDir, root) {
|
|
|
81
81
|
}
|
|
82
82
|
return { status: "pass", title: `Bridge route handler (${relative(root, bridge)})` };
|
|
83
83
|
}
|
|
84
|
-
function checkProvider(appDir, root) {
|
|
84
|
+
function checkProvider(appDir, root, env) {
|
|
85
85
|
const layouts = walk(appDir, ["layout.tsx", "layout.jsx"]);
|
|
86
86
|
const hosting = layouts.filter((path) => /<ConnectProvider/.test(read(path)));
|
|
87
87
|
if (hosting.length === 0) {
|
|
88
88
|
return {
|
|
89
89
|
status: "fail",
|
|
90
90
|
title: "ConnectProvider in a layout",
|
|
91
|
-
detail: 'Nothing renders <ConnectProvider>. Every client hook and component below it throws without one. In app/layout.tsx:\n import { ConnectProvider } from "@cosmoops/connect-sdk/client";\n <ConnectProvider>{children}</ConnectProvider>',
|
|
91
|
+
detail: 'Nothing renders <ConnectProvider>. Every client hook and component below it throws without one. In app/layout.tsx:\n import { connectProviderProps } from "@cosmoops/connect-sdk/next";\n import { ConnectProvider } from "@cosmoops/connect-sdk/client";\n <ConnectProvider {...connectProviderProps()}>{children}</ConnectProvider>',
|
|
92
92
|
};
|
|
93
93
|
}
|
|
94
94
|
// A nested provider re-fetches the session and keeps a second cache that the
|
|
@@ -101,8 +101,42 @@ function checkProvider(appDir, root) {
|
|
|
101
101
|
detail: `Found in ${hosting.length} layouts (${hosting.map((path) => relative(root, path)).join(", ")}). Nested providers keep separate caches, so a mutation in one is invisible to the other. Keep the outermost one only.`,
|
|
102
102
|
};
|
|
103
103
|
}
|
|
104
|
+
/*
|
|
105
|
+
* The split integration, and the reason this check exists at all.
|
|
106
|
+
*
|
|
107
|
+
* `CONNECT_APP_URL` points the *server* at a non-production Connect. It is
|
|
108
|
+
* not `NEXT_PUBLIC_`, so `ConnectProvider` cannot read it and defaults
|
|
109
|
+
* `appUrl` to production independently - and nothing fails. The API reads go
|
|
110
|
+
* to the configured instance while every destination the browser builds
|
|
111
|
+
* opens production: the user menu's Profile and Billing rows, the launcher's
|
|
112
|
+
* link for an unsubscribed application, the access gate's subscribe target,
|
|
113
|
+
* and checkout. Both applications built on this SDK shipped exactly that.
|
|
114
|
+
*
|
|
115
|
+
* `warn` rather than `fail`: the prop may be threaded from a parent Server
|
|
116
|
+
* Component into a `"use client"` shell, which is the documented shape for a
|
|
117
|
+
* shell needing `usePathname()` - and that assignment is not visible in the
|
|
118
|
+
* layout this reads. So this cannot tell from the outside, which is what
|
|
119
|
+
* `warn` means here.
|
|
120
|
+
*/
|
|
121
|
+
const pointedElsewhere = /^[ \t]*CONNECT_APP_URL[ \t]*=[ \t]*\S/m.test(env);
|
|
122
|
+
const carriesOrigin = /appUrl|connectProviderProps/.test(read(hosting[0]));
|
|
123
|
+
if (pointedElsewhere && !carriesOrigin) {
|
|
124
|
+
return {
|
|
125
|
+
status: "warn",
|
|
126
|
+
title: "ConnectProvider in a layout",
|
|
127
|
+
detail: `CONNECT_APP_URL is set, but ${relative(root, hosting[0])} passes no appUrl - so your server talks to that instance while every link the browser builds opens production Connect. Spread it in:\n <ConnectProvider {...connectProviderProps()}> // from "@cosmoops/connect-sdk/next"\n Already threading it into a "use client" shell? Then this is fine and you can ignore it.`,
|
|
128
|
+
};
|
|
129
|
+
}
|
|
104
130
|
return { status: "pass", title: `ConnectProvider in a layout (${relative(root, hosting[0])})` };
|
|
105
131
|
}
|
|
132
|
+
/** The env files `checkEnv` reads, as one string, shared with `checkProvider`. */
|
|
133
|
+
function envText(root) {
|
|
134
|
+
return [".env.local", ".env.development.local", ".env"]
|
|
135
|
+
.map((name) => join(root, name))
|
|
136
|
+
.filter(existsSync)
|
|
137
|
+
.map(read)
|
|
138
|
+
.join("\n");
|
|
139
|
+
}
|
|
106
140
|
/**
|
|
107
141
|
* Order is the whole check.
|
|
108
142
|
*
|
|
@@ -143,8 +177,7 @@ function checkTheme(root) {
|
|
|
143
177
|
* loaded it - exactly the shell `next dev` will inherit.
|
|
144
178
|
*/
|
|
145
179
|
function checkEnv(root) {
|
|
146
|
-
const
|
|
147
|
-
const combined = files.filter(existsSync).map(read).join("\n");
|
|
180
|
+
const combined = envText(root);
|
|
148
181
|
return ["CONNECT_API_KEY", "CONNECT_CLIENT_ID"].map((name) => {
|
|
149
182
|
// Horizontal whitespace only. `\s*` also matches the newline, so a bare
|
|
150
183
|
// `CONNECT_API_KEY=` was satisfied by the *next* line's value and an empty
|
|
@@ -188,7 +221,7 @@ export function runDoctor(argv = []) {
|
|
|
188
221
|
console.log(`[connect-sdk] Checking ${relative(process.cwd(), root) || root}\n`);
|
|
189
222
|
const checks = [
|
|
190
223
|
checkBridge(appDir, root),
|
|
191
|
-
checkProvider(appDir, root),
|
|
224
|
+
checkProvider(appDir, root, envText(root)),
|
|
192
225
|
checkTheme(root),
|
|
193
226
|
...checkEnv(root),
|
|
194
227
|
checkRedirectUri(),
|
|
@@ -28,22 +28,51 @@ export const RAIL_GUTTER = 12;
|
|
|
28
28
|
* The row shape every sidebar control shares - nav items, the workspace tile,
|
|
29
29
|
* the launcher, the user button.
|
|
30
30
|
*
|
|
31
|
+
* **The height is not here.** It rides on `SIDEBAR_ROW_ICON` /
|
|
32
|
+
* `SIDEBAR_ROW_TILE` instead, because the two glyph sizes want different
|
|
33
|
+
* heights and only one of them is in the region that overflows - see those
|
|
34
|
+
* two constants.
|
|
35
|
+
*
|
|
31
36
|
* `overflow-hidden` + `whitespace-nowrap` is what makes the collapse smooth:
|
|
32
37
|
* the label is *clipped* by the shrinking rail rather than re-wrapped or
|
|
33
38
|
* re-measured, so a width animation costs no reflow. Fading the label with
|
|
34
39
|
* `SidebarLabel` on top of that hides the clip itself.
|
|
35
40
|
*/
|
|
36
|
-
export const SIDEBAR_ROW = "group/row relative flex
|
|
41
|
+
export const SIDEBAR_ROW = "group/row relative flex w-full shrink-0 items-center justify-start gap-3 overflow-hidden whitespace-nowrap rounded-lg pe-2 text-sm font-normal transition-colors focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-focus";
|
|
37
42
|
/**
|
|
38
|
-
* Leading inset for a row whose glyph is 20px wide (a nav icon,
|
|
43
|
+
* Leading inset *and height* for a row whose glyph is 20px wide (a nav icon,
|
|
44
|
+
* the launcher, a secondary-nav row).
|
|
45
|
+
*
|
|
39
46
|
* `10 + 10 = 20`, and `RAIL_GUTTER + 20 = 32`. See `RAIL_COLLAPSED`.
|
|
47
|
+
*
|
|
48
|
+
* **36px, not 40px, and the height belongs on this axis rather than on
|
|
49
|
+
* `SIDEBAR_ROW`.** The nav is the only region of the rail that grows with the
|
|
50
|
+
* host's route count, and `ConnectSidebarBody` is the only region that
|
|
51
|
+
* scrolls - so a rail that overflows overflows here. Ten destinations at 40px
|
|
52
|
+
* came to 436px of nav against 273px of fixed chrome (header, switcher, two
|
|
53
|
+
* footers), which needs a 709px viewport to sit still; a 1366x768 screen has
|
|
54
|
+
* about 678px of it. Four pixels a row is 48px back across the twelve rows a
|
|
55
|
+
* real integration draws, and 36px is still comfortably past the 24px
|
|
56
|
+
* WCAG 2.5.8 target minimum with the row's full width as the hit area.
|
|
57
|
+
*
|
|
58
|
+
* It is deliberately *not* a smaller glyph. The 20px box is a flex centring
|
|
59
|
+
* container for an icon the **host** supplies at its own size, so shrinking
|
|
60
|
+
* the box buys no vertical space and only pushes the icon off the 32px centre
|
|
61
|
+
* the collapsed rail is built on.
|
|
40
62
|
*/
|
|
41
|
-
export const SIDEBAR_ROW_ICON = "ps-[10px]";
|
|
63
|
+
export const SIDEBAR_ROW_ICON = "h-9 ps-[10px]";
|
|
42
64
|
/**
|
|
43
|
-
* Leading inset for a row whose glyph is 32px wide (the avatar, the
|
|
44
|
-
* tile). `4 + 16 = 20`, landing on the same 32px centre as
|
|
65
|
+
* Leading inset and height for a row whose glyph is 32px wide (the avatar, the
|
|
66
|
+
* workspace tile). `4 + 16 = 20`, landing on the same 32px centre as
|
|
67
|
+
* `SIDEBAR_ROW_ICON`.
|
|
68
|
+
*
|
|
69
|
+
* **These stay at 40px.** There are exactly two of them and neither scales
|
|
70
|
+
* with the host's nav, so they are not what overflows - and both need the
|
|
71
|
+
* height: a 32px tile in a 36px row has 2px of air, and the account row's
|
|
72
|
+
* label is two lines (name over email, `leading-tight`) which measures ~32px
|
|
73
|
+
* on its own.
|
|
45
74
|
*/
|
|
46
|
-
export const SIDEBAR_ROW_TILE = "ps-[4px]";
|
|
75
|
+
export const SIDEBAR_ROW_TILE = "h-10 ps-[4px]";
|
|
47
76
|
/**
|
|
48
77
|
* The class list for one sidebar row, in one place.
|
|
49
78
|
*
|
|
@@ -109,7 +109,12 @@ export function ConnectSidebarBody({ children }) {
|
|
|
109
109
|
// zoom away over a region of text is a WCAG 1.4.4 failure, and nothing
|
|
110
110
|
// here needs it suppressed. On the desktop rail, where no ancestor
|
|
111
111
|
// restricts anything, the pair is equivalent to the default.
|
|
112
|
-
|
|
112
|
+
// `py-1` rather than the `py-2` every other region carries: this is the
|
|
113
|
+
// one region that scrolls, so it is the first place to give up air when
|
|
114
|
+
// the nav is a row or two from overflowing. The rows paint their own
|
|
115
|
+
// rounded background, so the hairline above the footer is still clear of
|
|
116
|
+
// them. See `SIDEBAR_ROW_ICON` for the arithmetic this is part of.
|
|
117
|
+
_jsx("div", { className: "flex min-h-0 flex-1 touch-pan-y touch-pinch-zoom flex-col gap-1 overflow-y-auto overflow-x-hidden px-3 py-1", children: children }));
|
|
113
118
|
}
|
|
114
119
|
/**
|
|
115
120
|
* A pinned region at the foot of the rail - the secondary nav, the launcher,
|
package/dist/esm/next/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { cache } from "react";
|
|
2
|
-
import { ConnectClient } from "../server/client.js";
|
|
2
|
+
import { ConnectClient, DEFAULT_BASE_URL } from "../server/client.js";
|
|
3
3
|
import { createConnectHandler } from "../server/handler.js";
|
|
4
4
|
import { ConnectError } from "../errors.js";
|
|
5
5
|
/**
|
|
@@ -24,8 +24,9 @@ import { ConnectError } from "../errors.js";
|
|
|
24
24
|
*
|
|
25
25
|
* ```tsx
|
|
26
26
|
* // app/layout.tsx
|
|
27
|
+
* import { connectProviderProps } from "@cosmoops/connect-sdk/next";
|
|
27
28
|
* import { ConnectProvider } from "@cosmoops/connect-sdk/client";
|
|
28
|
-
* <ConnectProvider>{children}</ConnectProvider>
|
|
29
|
+
* <ConnectProvider {...connectProviderProps()}>{children}</ConnectProvider>
|
|
29
30
|
* ```
|
|
30
31
|
*
|
|
31
32
|
* No `next.config.ts` changes needed - configuration comes from the
|
|
@@ -42,6 +43,10 @@ import { ConnectError } from "../errors.js";
|
|
|
42
43
|
* `ConnectProvider` defaults `appUrl` to the production origin independently,
|
|
43
44
|
* so an app pointed at another instance must pass that prop as well or its
|
|
44
45
|
* portal links and its browser-built authorize URL still go to production.
|
|
46
|
+
* That is what the `connectProviderProps()` spread above is for, and why the
|
|
47
|
+
* layout is two imports rather than one - leave it off and the server half and
|
|
48
|
+
* the browser half of the same integration address different instances, with
|
|
49
|
+
* nothing failing to say so. See that function's own docs.
|
|
45
50
|
*
|
|
46
51
|
* Register `{your origin}/api/connect/callback` as a redirect URI in the
|
|
47
52
|
* application's Connect client section. That is the only step this cannot do
|
|
@@ -82,6 +87,55 @@ export function connectClient(overrides = {}) {
|
|
|
82
87
|
cached = client;
|
|
83
88
|
return client;
|
|
84
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* The `ConnectProvider` props that come from the environment.
|
|
92
|
+
*
|
|
93
|
+
* ```tsx
|
|
94
|
+
* // app/layout.tsx - a Server Component
|
|
95
|
+
* import { connectProviderProps } from "@cosmoops/connect-sdk/next";
|
|
96
|
+
* import { ConnectProvider } from "@cosmoops/connect-sdk/client";
|
|
97
|
+
*
|
|
98
|
+
* <ConnectProvider {...connectProviderProps()}>{children}</ConnectProvider>
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
101
|
+
* ## What it is for
|
|
102
|
+
*
|
|
103
|
+
* `CONNECT_APP_URL` points the *server* at a non-production Connect. It is not
|
|
104
|
+
* `NEXT_PUBLIC_`, so it never reaches the browser, and `ConnectProvider`
|
|
105
|
+
* defaults `appUrl` to the production origin independently - so pointing the
|
|
106
|
+
* server somewhere else and leaving the prop off splits the integration in
|
|
107
|
+
* half. The server talks to dev and every destination the browser builds opens
|
|
108
|
+
* production: the user menu's Profile and Billing rows, the app launcher's link
|
|
109
|
+
* for an unsubscribed application, `ConnectAccessGate`'s subscribe target, and
|
|
110
|
+
* checkout. Nothing errors. The customer is simply asked to buy a second
|
|
111
|
+
* subscription in an instance where they have none.
|
|
112
|
+
*
|
|
113
|
+
* Both apps built on this SDK shipped that bug before anyone noticed, from
|
|
114
|
+
* reading "the provider takes no props" as a rule rather than as a remark about
|
|
115
|
+
* `clientId`. A root layout is a Server Component, so one spread fixes it with
|
|
116
|
+
* no browser-visible copy of the variable.
|
|
117
|
+
*
|
|
118
|
+
* ## What it deliberately leaves out
|
|
119
|
+
*
|
|
120
|
+
* `clientId` and `basePath`. The first is only needed alongside an explicit
|
|
121
|
+
* `redirectUri`, when you build the authorize URL in the browser rather than
|
|
122
|
+
* letting `signIn()` bounce through your own `/signin` route - and handing the
|
|
123
|
+
* browser a value it does not need is surface for nothing. The second is where
|
|
124
|
+
* *you* mounted the handler, which the environment does not know. Pass either
|
|
125
|
+
* yourself; a prop you pass always wins over this spread, whichever order you
|
|
126
|
+
* write them in, as long as the spread comes first.
|
|
127
|
+
*
|
|
128
|
+
* ## If you already have an origin helper
|
|
129
|
+
*
|
|
130
|
+
* Use it instead. An app that builds its own links into Connect (a "Manage
|
|
131
|
+
* team" button, a pricing page's subscribe target) needs that origin on the
|
|
132
|
+
* server too, and one function owning the read is better than this helper
|
|
133
|
+
* beside it - two readers of one variable is the shape that caused this. This
|
|
134
|
+
* exists for the integration that has no such helper, which is most of them.
|
|
135
|
+
*/
|
|
136
|
+
export function connectProviderProps() {
|
|
137
|
+
return { appUrl: (process.env.CONNECT_APP_URL ?? DEFAULT_BASE_URL).replace(/\/+$/, "") };
|
|
138
|
+
}
|
|
85
139
|
/**
|
|
86
140
|
* An httpOnly cookie holding the opaque `sessionToken`.
|
|
87
141
|
*
|
|
@@ -25,22 +25,51 @@ export declare const RAIL_GUTTER = 12;
|
|
|
25
25
|
* The row shape every sidebar control shares - nav items, the workspace tile,
|
|
26
26
|
* the launcher, the user button.
|
|
27
27
|
*
|
|
28
|
+
* **The height is not here.** It rides on `SIDEBAR_ROW_ICON` /
|
|
29
|
+
* `SIDEBAR_ROW_TILE` instead, because the two glyph sizes want different
|
|
30
|
+
* heights and only one of them is in the region that overflows - see those
|
|
31
|
+
* two constants.
|
|
32
|
+
*
|
|
28
33
|
* `overflow-hidden` + `whitespace-nowrap` is what makes the collapse smooth:
|
|
29
34
|
* the label is *clipped* by the shrinking rail rather than re-wrapped or
|
|
30
35
|
* re-measured, so a width animation costs no reflow. Fading the label with
|
|
31
36
|
* `SidebarLabel` on top of that hides the clip itself.
|
|
32
37
|
*/
|
|
33
|
-
export declare const SIDEBAR_ROW = "group/row relative flex
|
|
38
|
+
export declare const SIDEBAR_ROW = "group/row relative flex w-full shrink-0 items-center justify-start gap-3 overflow-hidden whitespace-nowrap rounded-lg pe-2 text-sm font-normal transition-colors focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-focus";
|
|
34
39
|
/**
|
|
35
|
-
* Leading inset for a row whose glyph is 20px wide (a nav icon,
|
|
40
|
+
* Leading inset *and height* for a row whose glyph is 20px wide (a nav icon,
|
|
41
|
+
* the launcher, a secondary-nav row).
|
|
42
|
+
*
|
|
36
43
|
* `10 + 10 = 20`, and `RAIL_GUTTER + 20 = 32`. See `RAIL_COLLAPSED`.
|
|
44
|
+
*
|
|
45
|
+
* **36px, not 40px, and the height belongs on this axis rather than on
|
|
46
|
+
* `SIDEBAR_ROW`.** The nav is the only region of the rail that grows with the
|
|
47
|
+
* host's route count, and `ConnectSidebarBody` is the only region that
|
|
48
|
+
* scrolls - so a rail that overflows overflows here. Ten destinations at 40px
|
|
49
|
+
* came to 436px of nav against 273px of fixed chrome (header, switcher, two
|
|
50
|
+
* footers), which needs a 709px viewport to sit still; a 1366x768 screen has
|
|
51
|
+
* about 678px of it. Four pixels a row is 48px back across the twelve rows a
|
|
52
|
+
* real integration draws, and 36px is still comfortably past the 24px
|
|
53
|
+
* WCAG 2.5.8 target minimum with the row's full width as the hit area.
|
|
54
|
+
*
|
|
55
|
+
* It is deliberately *not* a smaller glyph. The 20px box is a flex centring
|
|
56
|
+
* container for an icon the **host** supplies at its own size, so shrinking
|
|
57
|
+
* the box buys no vertical space and only pushes the icon off the 32px centre
|
|
58
|
+
* the collapsed rail is built on.
|
|
37
59
|
*/
|
|
38
|
-
export declare const SIDEBAR_ROW_ICON = "ps-[10px]";
|
|
60
|
+
export declare const SIDEBAR_ROW_ICON = "h-9 ps-[10px]";
|
|
39
61
|
/**
|
|
40
|
-
* Leading inset for a row whose glyph is 32px wide (the avatar, the
|
|
41
|
-
* tile). `4 + 16 = 20`, landing on the same 32px centre as
|
|
62
|
+
* Leading inset and height for a row whose glyph is 32px wide (the avatar, the
|
|
63
|
+
* workspace tile). `4 + 16 = 20`, landing on the same 32px centre as
|
|
64
|
+
* `SIDEBAR_ROW_ICON`.
|
|
65
|
+
*
|
|
66
|
+
* **These stay at 40px.** There are exactly two of them and neither scales
|
|
67
|
+
* with the host's nav, so they are not what overflows - and both need the
|
|
68
|
+
* height: a 32px tile in a 36px row has 2px of air, and the account row's
|
|
69
|
+
* label is two lines (name over email, `leading-tight`) which measures ~32px
|
|
70
|
+
* on its own.
|
|
42
71
|
*/
|
|
43
|
-
export declare const SIDEBAR_ROW_TILE = "ps-[4px]";
|
|
72
|
+
export declare const SIDEBAR_ROW_TILE = "h-10 ps-[4px]";
|
|
44
73
|
/**
|
|
45
74
|
* The class list for one sidebar row, in one place.
|
|
46
75
|
*
|
|
@@ -57,7 +86,10 @@ export declare const SIDEBAR_ROW_TILE = "ps-[4px]";
|
|
|
57
86
|
* lets a `w-fit`, centred, `px-`-padded button take this shape at all.
|
|
58
87
|
*/
|
|
59
88
|
export declare function sidebarRowClass(options?: Readonly<{
|
|
60
|
-
/**
|
|
89
|
+
/**
|
|
90
|
+
* The glyph is 32px (an avatar, a workspace tile) rather than 20px - which
|
|
91
|
+
* also makes the row 40px rather than 36px. See `SIDEBAR_ROW_TILE`.
|
|
92
|
+
*/
|
|
61
93
|
tile?: boolean;
|
|
62
94
|
/** Paint the active treatment. */
|
|
63
95
|
active?: boolean;
|
|
@@ -73,13 +73,13 @@ export declare function ConnectSidebarFooter({ children, separated, }: Readonly<
|
|
|
73
73
|
separated?: boolean;
|
|
74
74
|
}>): import("react").JSX.Element;
|
|
75
75
|
export type ConnectSidebarRowProps = Readonly<{
|
|
76
|
-
/** The glyph. 20px by default; 32px when `tile`. */
|
|
76
|
+
/** The glyph. 20px in a 36px row by default; 32px in a 40px row when `tile`. */
|
|
77
77
|
icon: ReactNode;
|
|
78
78
|
/** The row's text, and - when it is a string - its accessible name. */
|
|
79
79
|
label: ReactNode;
|
|
80
80
|
/** Overrides the accessible name. Required when `label` is not a string. */
|
|
81
81
|
"aria-label"?: string;
|
|
82
|
-
/** The glyph is 32px (an avatar, a workspace tile) rather than 20px. */
|
|
82
|
+
/** The glyph is 32px (an avatar, a workspace tile) rather than 20px, in a 40px row. */
|
|
83
83
|
tile?: boolean;
|
|
84
84
|
/** Trailing content, e.g. a chevron. Clipped with the label while collapsed. */
|
|
85
85
|
trailing?: ReactNode;
|
|
@@ -9,6 +9,55 @@ import type { UserResponse } from "../types.js";
|
|
|
9
9
|
* are frequently absent.
|
|
10
10
|
*/
|
|
11
11
|
export declare function connectClient(overrides?: Partial<ConnectClientOptions>): ConnectClient;
|
|
12
|
+
/**
|
|
13
|
+
* The `ConnectProvider` props that come from the environment.
|
|
14
|
+
*
|
|
15
|
+
* ```tsx
|
|
16
|
+
* // app/layout.tsx - a Server Component
|
|
17
|
+
* import { connectProviderProps } from "@cosmoops/connect-sdk/next";
|
|
18
|
+
* import { ConnectProvider } from "@cosmoops/connect-sdk/client";
|
|
19
|
+
*
|
|
20
|
+
* <ConnectProvider {...connectProviderProps()}>{children}</ConnectProvider>
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* ## What it is for
|
|
24
|
+
*
|
|
25
|
+
* `CONNECT_APP_URL` points the *server* at a non-production Connect. It is not
|
|
26
|
+
* `NEXT_PUBLIC_`, so it never reaches the browser, and `ConnectProvider`
|
|
27
|
+
* defaults `appUrl` to the production origin independently - so pointing the
|
|
28
|
+
* server somewhere else and leaving the prop off splits the integration in
|
|
29
|
+
* half. The server talks to dev and every destination the browser builds opens
|
|
30
|
+
* production: the user menu's Profile and Billing rows, the app launcher's link
|
|
31
|
+
* for an unsubscribed application, `ConnectAccessGate`'s subscribe target, and
|
|
32
|
+
* checkout. Nothing errors. The customer is simply asked to buy a second
|
|
33
|
+
* subscription in an instance where they have none.
|
|
34
|
+
*
|
|
35
|
+
* Both apps built on this SDK shipped that bug before anyone noticed, from
|
|
36
|
+
* reading "the provider takes no props" as a rule rather than as a remark about
|
|
37
|
+
* `clientId`. A root layout is a Server Component, so one spread fixes it with
|
|
38
|
+
* no browser-visible copy of the variable.
|
|
39
|
+
*
|
|
40
|
+
* ## What it deliberately leaves out
|
|
41
|
+
*
|
|
42
|
+
* `clientId` and `basePath`. The first is only needed alongside an explicit
|
|
43
|
+
* `redirectUri`, when you build the authorize URL in the browser rather than
|
|
44
|
+
* letting `signIn()` bounce through your own `/signin` route - and handing the
|
|
45
|
+
* browser a value it does not need is surface for nothing. The second is where
|
|
46
|
+
* *you* mounted the handler, which the environment does not know. Pass either
|
|
47
|
+
* yourself; a prop you pass always wins over this spread, whichever order you
|
|
48
|
+
* write them in, as long as the spread comes first.
|
|
49
|
+
*
|
|
50
|
+
* ## If you already have an origin helper
|
|
51
|
+
*
|
|
52
|
+
* Use it instead. An app that builds its own links into Connect (a "Manage
|
|
53
|
+
* team" button, a pricing page's subscribe target) needs that origin on the
|
|
54
|
+
* server too, and one function owning the read is better than this helper
|
|
55
|
+
* beside it - two readers of one variable is the shape that caused this. This
|
|
56
|
+
* exists for the integration that has no such helper, which is most of them.
|
|
57
|
+
*/
|
|
58
|
+
export declare function connectProviderProps(): {
|
|
59
|
+
appUrl: string;
|
|
60
|
+
};
|
|
12
61
|
/**
|
|
13
62
|
* An httpOnly cookie holding the opaque `sessionToken`.
|
|
14
63
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cosmoops/connect-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.35.0",
|
|
4
4
|
"description": "Official server-side SDK for the CosmoOps Connect platform API - Login with Connect, entitlements, billing and metering.",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE",
|
|
6
6
|
"type": "commonjs",
|