@hexclave/shared 1.0.9 → 1.0.10
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/ai/unified-prompts/reminders.js +1 -0
- package/dist/ai/unified-prompts/reminders.js.map +1 -1
- package/dist/config/schema.d.ts +155 -155
- package/dist/esm/ai/unified-prompts/reminders.js +1 -0
- package/dist/esm/ai/unified-prompts/reminders.js.map +1 -1
- package/dist/esm/config/schema.d.ts +155 -155
- package/dist/esm/interface/crud/email-outbox.d.ts +44 -44
- package/dist/interface/crud/email-outbox.d.ts +44 -44
- package/package.json +1 -1
- package/src/ai/unified-prompts/reminders.ts +1 -0
|
@@ -21,6 +21,7 @@ const remindersPrompt = ______utils_strings_js.deindent`
|
|
|
21
21
|
- Language, framework, and library-specific details:
|
|
22
22
|
- JavaScript & TypeScript:
|
|
23
23
|
- Hexclave has different SDK packages for different frameworks and languages. As of the time of writing these reminders, they are: @hexclave/js (JavaScript/TypeScript), @hexclave/next (Next.js), @hexclave/react (React), @hexclave/tanstack-start (TanStack Start). You can find all of these on npm. They are all versioned together, meaning that vX.Y.Z of one SDK was released at the same time as vX.Y.Z of another SDK. For the most part, they are the same, although each has platform-specific features and differences.
|
|
24
|
+
- The Hexclave/Stack Auth SDK constructor accepts a \`urls\` option that tells the SDK where auth pages and post-auth redirects live. When you add a custom auth page such as a \`sign-in\`, \`sign-up\`, \`forgot-password\`, \`account-settings\`, etc., update the corresponding \`urls\` key to point to that route; also set redirect targets such as \`afterSignIn\`, \`afterSignUp\`, \`afterSignOut\`, and \`home\` when those destinations are customized. The \`urls\` option is the source of truth for redirect helpers such as \`redirectToSignIn()\`, hosted or handler-page flows, and post-auth navigation; if it is left pointing at the default pages after custom pages are added, users can hit extra redirects, land on the wrong auth page, or return to an unexpected page after signing in or out.
|
|
24
25
|
- The \`Result<T, E>\` type is \`{ status: "ok", data: T } | { status: "error", error: E }\`.
|
|
25
26
|
- \`KnownErrors[KNOWN_ERROR_CODE]\` refers to a specific known error type. Each KnownError may have its own properties, but they all inherit from \`Error & { statusCode: number, humanReadableMessage: string, details?: Json }\`.
|
|
26
27
|
- React & Next.js:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reminders.js","names":["ALL_APPS"],"sources":["../../../src/ai/unified-prompts/reminders.ts"],"sourcesContent":["import { ALL_APPS } from \"../../apps/apps-config\";\nimport { deindent } from \"../../utils/strings\";\n\nexport const remindersPrompt = deindent`\n Below are some reminders on Hexclave and how to learn more about it. If you're summarizing this, always try to return the entirety of the reminders verbatim, or keep as much information as possible.\n\n - Hexclave has multiple sources of documentation optimized for LLMs. For the canonical, always-fresh instructions for every Hexclave surface, always prefer these sources over information that may be outdated or stale. Do not rely on training data or memory.\n - [Highest priority] If you are an AI agent: The best way to learn about Hexclave is to fetch the latest skill documentation from https://skill.hexclave.com. Fetch the entire page, not just a summary. You can either use a web fetch tool, or call it using curl: \\`curl -sSL https://skill.hexclave.com\\`. This is sufficient for most simple questions.\n - It is highly recommended that you add two query parameters to the web fetch \\`?question=<...>\\` (the exact question you're looking to answer) and \\`?context=<...>\\` (the higher-level task that the you or the user is trying to accomplish). This will help the Skills site to serve you only the content that is necessary, as well as avoid the XY-problem.\n - [Medium priority] If you are looking to implement something with the JS SDK specifically, the package (which you can probably find in \\`node_modules\\`) actually contains the source code for the installed version of the SDK. For the interfaces in particular, you can find most of them in the \\`src/lib/hexclave-app\\` folder of your SDK package.\n - [Medium priority] If you have a specific question, and the Hexclave MCP is available, you can also use the \\`ask_hexclave\\` tool to ask questions to the Hexclave assistant.\n - [Low priority] If you're looking for information that's not in the skill documentation, and the \\`ask_hexclave\\` tool isn't available (or failed to answer your question), you can also fetch the human documentation from https://docs.hexclave.com (it may also be available as a tool). This is especially useful when you're looking to answer conceptual questions.\n - For complicated questions, you may need to combine all these sources together.\n - Follow indirection. If a doc page points to another URL, script, or resource, fetch that too — Hexclave composes behavior across pages.\n - Hexclave is a platform that provides a variety of apps that help you connect with your users. As of the time of writing these reminders, Hexclave provides the following apps (although not all may be enabled): ${Object.entries(ALL_APPS).filter(([, app]) => app.stage !== \"alpha\").map(([key]) => key).join(\", \")}. Don't hardcode this list, as it changes rapidly.\n - The most important object in Hexclave is the Hexclave App object. HexclaveClientApp provides client-side functionality, while HexclaveServerApp also provides server-side functionality (but can usually only be imported on the server, as it requires a secret server key environment variable). You can usually find an instance of this object in a file called \\`hexclave/client.tsx\\` or \\`hexclave/server.tsx\\`, although it may be in a different location in this particular codebase.\n - Take extra care to always have great error handling and loading states whenever necessary (including in button onClick handlers; Hexclave's code examples often use a special onClick class which handles loading states, but your own button may not). Hexclave's SDK tends to return errors that need to be handled explicitly in its return types.\n - Language, framework, and library-specific details:\n - JavaScript & TypeScript:\n - Hexclave has different SDK packages for different frameworks and languages. As of the time of writing these reminders, they are: @hexclave/js (JavaScript/TypeScript), @hexclave/next (Next.js), @hexclave/react (React), @hexclave/tanstack-start (TanStack Start). You can find all of these on npm. They are all versioned together, meaning that vX.Y.Z of one SDK was released at the same time as vX.Y.Z of another SDK. For the most part, they are the same, although each has platform-specific features and differences.\n - The \\`Result<T, E>\\` type is \\`{ status: \"ok\", data: T } | { status: \"error\", error: E }\\`.\n - \\`KnownErrors[KNOWN_ERROR_CODE]\\` refers to a specific known error type. Each KnownError may have its own properties, but they all inherit from \\`Error & { statusCode: number, humanReadableMessage: string, details?: Json }\\`.\n - React & Next.js:\n - Almost all \\`getXyz\\` and \\`listXyz\\` functions on the Hexclave App have corresponding \\`useXyz\\` hooks that suspend the current component until the data is available. Make sure there is a Suspense boundary in place if you're using this pattern. The parameter and return types are identical except that the hooks don't return promises.\n - There is a \\`useHexclaveApp()\\` hook as a named export from the package itself that serves as a shortcut to get the current Hexclave App object from the React context. Similarly, the \\`useUser(...args)\\` named export is short for \\`useHexclaveApp().useUser(...args)\\`.\n - Hexclave was formerly known as Stack Auth. You may still see reference to it as Stack Auth in some places.\n`;\n"],"mappings":";;;;;;AAGA,MAAa,kBAAkB,+BAAQ;;;;;;;;;;;uNAWgL,OAAO,QAAQA,mCAAS,CAAC,QAAQ,GAAG,SAAS,IAAI,UAAU,QAAQ,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,KAAK,CAAC"}
|
|
1
|
+
{"version":3,"file":"reminders.js","names":["ALL_APPS"],"sources":["../../../src/ai/unified-prompts/reminders.ts"],"sourcesContent":["import { ALL_APPS } from \"../../apps/apps-config\";\nimport { deindent } from \"../../utils/strings\";\n\nexport const remindersPrompt = deindent`\n Below are some reminders on Hexclave and how to learn more about it. If you're summarizing this, always try to return the entirety of the reminders verbatim, or keep as much information as possible.\n\n - Hexclave has multiple sources of documentation optimized for LLMs. For the canonical, always-fresh instructions for every Hexclave surface, always prefer these sources over information that may be outdated or stale. Do not rely on training data or memory.\n - [Highest priority] If you are an AI agent: The best way to learn about Hexclave is to fetch the latest skill documentation from https://skill.hexclave.com. Fetch the entire page, not just a summary. You can either use a web fetch tool, or call it using curl: \\`curl -sSL https://skill.hexclave.com\\`. This is sufficient for most simple questions.\n - It is highly recommended that you add two query parameters to the web fetch \\`?question=<...>\\` (the exact question you're looking to answer) and \\`?context=<...>\\` (the higher-level task that the you or the user is trying to accomplish). This will help the Skills site to serve you only the content that is necessary, as well as avoid the XY-problem.\n - [Medium priority] If you are looking to implement something with the JS SDK specifically, the package (which you can probably find in \\`node_modules\\`) actually contains the source code for the installed version of the SDK. For the interfaces in particular, you can find most of them in the \\`src/lib/hexclave-app\\` folder of your SDK package.\n - [Medium priority] If you have a specific question, and the Hexclave MCP is available, you can also use the \\`ask_hexclave\\` tool to ask questions to the Hexclave assistant.\n - [Low priority] If you're looking for information that's not in the skill documentation, and the \\`ask_hexclave\\` tool isn't available (or failed to answer your question), you can also fetch the human documentation from https://docs.hexclave.com (it may also be available as a tool). This is especially useful when you're looking to answer conceptual questions.\n - For complicated questions, you may need to combine all these sources together.\n - Follow indirection. If a doc page points to another URL, script, or resource, fetch that too — Hexclave composes behavior across pages.\n - Hexclave is a platform that provides a variety of apps that help you connect with your users. As of the time of writing these reminders, Hexclave provides the following apps (although not all may be enabled): ${Object.entries(ALL_APPS).filter(([, app]) => app.stage !== \"alpha\").map(([key]) => key).join(\", \")}. Don't hardcode this list, as it changes rapidly.\n - The most important object in Hexclave is the Hexclave App object. HexclaveClientApp provides client-side functionality, while HexclaveServerApp also provides server-side functionality (but can usually only be imported on the server, as it requires a secret server key environment variable). You can usually find an instance of this object in a file called \\`hexclave/client.tsx\\` or \\`hexclave/server.tsx\\`, although it may be in a different location in this particular codebase.\n - Take extra care to always have great error handling and loading states whenever necessary (including in button onClick handlers; Hexclave's code examples often use a special onClick class which handles loading states, but your own button may not). Hexclave's SDK tends to return errors that need to be handled explicitly in its return types.\n - Language, framework, and library-specific details:\n - JavaScript & TypeScript:\n - Hexclave has different SDK packages for different frameworks and languages. As of the time of writing these reminders, they are: @hexclave/js (JavaScript/TypeScript), @hexclave/next (Next.js), @hexclave/react (React), @hexclave/tanstack-start (TanStack Start). You can find all of these on npm. They are all versioned together, meaning that vX.Y.Z of one SDK was released at the same time as vX.Y.Z of another SDK. For the most part, they are the same, although each has platform-specific features and differences.\n - The Hexclave/Stack Auth SDK constructor accepts a \\`urls\\` option that tells the SDK where auth pages and post-auth redirects live. When you add a custom auth page such as a \\`sign-in\\`, \\`sign-up\\`, \\`forgot-password\\`, \\`account-settings\\`, etc., update the corresponding \\`urls\\` key to point to that route; also set redirect targets such as \\`afterSignIn\\`, \\`afterSignUp\\`, \\`afterSignOut\\`, and \\`home\\` when those destinations are customized. The \\`urls\\` option is the source of truth for redirect helpers such as \\`redirectToSignIn()\\`, hosted or handler-page flows, and post-auth navigation; if it is left pointing at the default pages after custom pages are added, users can hit extra redirects, land on the wrong auth page, or return to an unexpected page after signing in or out.\n - The \\`Result<T, E>\\` type is \\`{ status: \"ok\", data: T } | { status: \"error\", error: E }\\`.\n - \\`KnownErrors[KNOWN_ERROR_CODE]\\` refers to a specific known error type. Each KnownError may have its own properties, but they all inherit from \\`Error & { statusCode: number, humanReadableMessage: string, details?: Json }\\`.\n - React & Next.js:\n - Almost all \\`getXyz\\` and \\`listXyz\\` functions on the Hexclave App have corresponding \\`useXyz\\` hooks that suspend the current component until the data is available. Make sure there is a Suspense boundary in place if you're using this pattern. The parameter and return types are identical except that the hooks don't return promises.\n - There is a \\`useHexclaveApp()\\` hook as a named export from the package itself that serves as a shortcut to get the current Hexclave App object from the React context. Similarly, the \\`useUser(...args)\\` named export is short for \\`useHexclaveApp().useUser(...args)\\`.\n - Hexclave was formerly known as Stack Auth. You may still see reference to it as Stack Auth in some places.\n`;\n"],"mappings":";;;;;;AAGA,MAAa,kBAAkB,+BAAQ;;;;;;;;;;;uNAWgL,OAAO,QAAQA,mCAAS,CAAC,QAAQ,GAAG,SAAS,IAAI,UAAU,QAAQ,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,KAAK,CAAC"}
|
package/dist/config/schema.d.ts
CHANGED
|
@@ -84,7 +84,7 @@ declare const branchConfigSchema: yup$1.Schema<Omit<Omit<{
|
|
|
84
84
|
sourceOfTruth: {
|
|
85
85
|
type: "hosted";
|
|
86
86
|
};
|
|
87
|
-
}, string>, "
|
|
87
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
88
88
|
payments?: {
|
|
89
89
|
blockNewPurchases?: boolean | undefined;
|
|
90
90
|
autoPay?: {
|
|
@@ -125,40 +125,6 @@ declare const branchConfigSchema: yup$1.Schema<Omit<Omit<{
|
|
|
125
125
|
}>;
|
|
126
126
|
}>;
|
|
127
127
|
} | undefined;
|
|
128
|
-
users: {
|
|
129
|
-
allowClientUserDeletion?: boolean | undefined;
|
|
130
|
-
};
|
|
131
|
-
teams: {
|
|
132
|
-
createPersonalTeamOnSignUp?: boolean | undefined;
|
|
133
|
-
allowClientTeamCreation?: boolean | undefined;
|
|
134
|
-
};
|
|
135
|
-
rbac: {
|
|
136
|
-
permissions: Record<string, {
|
|
137
|
-
description?: string | undefined;
|
|
138
|
-
scope?: "team" | "project" | undefined;
|
|
139
|
-
containedPermissionIds?: Record<string, true | undefined> | undefined;
|
|
140
|
-
} | undefined>;
|
|
141
|
-
defaultPermissions: {
|
|
142
|
-
teamCreator: Record<string, true | undefined>;
|
|
143
|
-
teamMember: Record<string, true | undefined>;
|
|
144
|
-
signUp: Record<string, true | undefined>;
|
|
145
|
-
};
|
|
146
|
-
};
|
|
147
|
-
onboarding: {
|
|
148
|
-
requireEmailVerification?: boolean | undefined;
|
|
149
|
-
};
|
|
150
|
-
apiKeys: {
|
|
151
|
-
enabled: {
|
|
152
|
-
team?: boolean | undefined;
|
|
153
|
-
user?: boolean | undefined;
|
|
154
|
-
};
|
|
155
|
-
};
|
|
156
|
-
apps: {
|
|
157
|
-
installed: Record<"teams" | "rbac" | "onboarding" | "payments" | "authentication" | "fraud-protection" | "api-keys" | "emails" | "support" | "email-api" | "data-vault" | "webhooks" | "tv-mode" | "launch-checklist" | "catalyst" | "neon" | "convex" | "vercel" | "tanstack-start" | "analytics" | "session-replays", {
|
|
158
|
-
enabled?: boolean | undefined;
|
|
159
|
-
}>;
|
|
160
|
-
};
|
|
161
|
-
domains: {};
|
|
162
128
|
auth: {
|
|
163
129
|
allowSignUp?: boolean | undefined;
|
|
164
130
|
signUpRulesDefaultAction?: string | undefined;
|
|
@@ -190,6 +156,25 @@ declare const branchConfigSchema: yup$1.Schema<Omit<Omit<{
|
|
|
190
156
|
};
|
|
191
157
|
}>;
|
|
192
158
|
};
|
|
159
|
+
onboarding: {
|
|
160
|
+
requireEmailVerification?: boolean | undefined;
|
|
161
|
+
};
|
|
162
|
+
teams: {
|
|
163
|
+
createPersonalTeamOnSignUp?: boolean | undefined;
|
|
164
|
+
allowClientTeamCreation?: boolean | undefined;
|
|
165
|
+
};
|
|
166
|
+
rbac: {
|
|
167
|
+
permissions: Record<string, {
|
|
168
|
+
description?: string | undefined;
|
|
169
|
+
scope?: "team" | "project" | undefined;
|
|
170
|
+
containedPermissionIds?: Record<string, true | undefined> | undefined;
|
|
171
|
+
} | undefined>;
|
|
172
|
+
defaultPermissions: {
|
|
173
|
+
teamCreator: Record<string, true | undefined>;
|
|
174
|
+
teamMember: Record<string, true | undefined>;
|
|
175
|
+
signUp: Record<string, true | undefined>;
|
|
176
|
+
};
|
|
177
|
+
};
|
|
193
178
|
emails: {
|
|
194
179
|
selectedThemeId?: string | undefined;
|
|
195
180
|
themes: Record<string, {
|
|
@@ -202,6 +187,21 @@ declare const branchConfigSchema: yup$1.Schema<Omit<Omit<{
|
|
|
202
187
|
tsxSource: string;
|
|
203
188
|
}>;
|
|
204
189
|
};
|
|
190
|
+
users: {
|
|
191
|
+
allowClientUserDeletion?: boolean | undefined;
|
|
192
|
+
};
|
|
193
|
+
apiKeys: {
|
|
194
|
+
enabled: {
|
|
195
|
+
team?: boolean | undefined;
|
|
196
|
+
user?: boolean | undefined;
|
|
197
|
+
};
|
|
198
|
+
};
|
|
199
|
+
apps: {
|
|
200
|
+
installed: Record<"authentication" | "fraud-protection" | "onboarding" | "teams" | "rbac" | "api-keys" | "payments" | "emails" | "support" | "email-api" | "data-vault" | "webhooks" | "tv-mode" | "launch-checklist" | "catalyst" | "neon" | "convex" | "vercel" | "tanstack-start" | "analytics" | "session-replays", {
|
|
201
|
+
enabled?: boolean | undefined;
|
|
202
|
+
}>;
|
|
203
|
+
};
|
|
204
|
+
domains: {};
|
|
205
205
|
dbSync: {
|
|
206
206
|
externalDatabases: Record<string, {
|
|
207
207
|
connectionString?: string | undefined;
|
|
@@ -218,7 +218,7 @@ declare const branchConfigSchema: yup$1.Schema<Omit<Omit<{
|
|
|
218
218
|
project: {
|
|
219
219
|
requirePublishableClientKey: undefined;
|
|
220
220
|
};
|
|
221
|
-
}, string>, "
|
|
221
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
222
222
|
rbac: {
|
|
223
223
|
permissions: undefined;
|
|
224
224
|
defaultPermissions: {
|
|
@@ -293,7 +293,7 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
293
293
|
sourceOfTruth: {
|
|
294
294
|
type: "hosted";
|
|
295
295
|
};
|
|
296
|
-
}, string>, "
|
|
296
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
297
297
|
payments?: {
|
|
298
298
|
blockNewPurchases?: boolean | undefined;
|
|
299
299
|
autoPay?: {
|
|
@@ -334,40 +334,6 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
334
334
|
}>;
|
|
335
335
|
}>;
|
|
336
336
|
} | undefined;
|
|
337
|
-
users: {
|
|
338
|
-
allowClientUserDeletion?: boolean | undefined;
|
|
339
|
-
};
|
|
340
|
-
teams: {
|
|
341
|
-
createPersonalTeamOnSignUp?: boolean | undefined;
|
|
342
|
-
allowClientTeamCreation?: boolean | undefined;
|
|
343
|
-
};
|
|
344
|
-
rbac: {
|
|
345
|
-
permissions: Record<string, {
|
|
346
|
-
description?: string | undefined;
|
|
347
|
-
scope?: "team" | "project" | undefined;
|
|
348
|
-
containedPermissionIds?: Record<string, true | undefined> | undefined;
|
|
349
|
-
} | undefined>;
|
|
350
|
-
defaultPermissions: {
|
|
351
|
-
teamCreator: Record<string, true | undefined>;
|
|
352
|
-
teamMember: Record<string, true | undefined>;
|
|
353
|
-
signUp: Record<string, true | undefined>;
|
|
354
|
-
};
|
|
355
|
-
};
|
|
356
|
-
onboarding: {
|
|
357
|
-
requireEmailVerification?: boolean | undefined;
|
|
358
|
-
};
|
|
359
|
-
apiKeys: {
|
|
360
|
-
enabled: {
|
|
361
|
-
team?: boolean | undefined;
|
|
362
|
-
user?: boolean | undefined;
|
|
363
|
-
};
|
|
364
|
-
};
|
|
365
|
-
apps: {
|
|
366
|
-
installed: Record<"teams" | "rbac" | "onboarding" | "payments" | "authentication" | "fraud-protection" | "api-keys" | "emails" | "support" | "email-api" | "data-vault" | "webhooks" | "tv-mode" | "launch-checklist" | "catalyst" | "neon" | "convex" | "vercel" | "tanstack-start" | "analytics" | "session-replays", {
|
|
367
|
-
enabled?: boolean | undefined;
|
|
368
|
-
}>;
|
|
369
|
-
};
|
|
370
|
-
domains: {};
|
|
371
337
|
auth: {
|
|
372
338
|
allowSignUp?: boolean | undefined;
|
|
373
339
|
signUpRulesDefaultAction?: string | undefined;
|
|
@@ -399,6 +365,25 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
399
365
|
};
|
|
400
366
|
}>;
|
|
401
367
|
};
|
|
368
|
+
onboarding: {
|
|
369
|
+
requireEmailVerification?: boolean | undefined;
|
|
370
|
+
};
|
|
371
|
+
teams: {
|
|
372
|
+
createPersonalTeamOnSignUp?: boolean | undefined;
|
|
373
|
+
allowClientTeamCreation?: boolean | undefined;
|
|
374
|
+
};
|
|
375
|
+
rbac: {
|
|
376
|
+
permissions: Record<string, {
|
|
377
|
+
description?: string | undefined;
|
|
378
|
+
scope?: "team" | "project" | undefined;
|
|
379
|
+
containedPermissionIds?: Record<string, true | undefined> | undefined;
|
|
380
|
+
} | undefined>;
|
|
381
|
+
defaultPermissions: {
|
|
382
|
+
teamCreator: Record<string, true | undefined>;
|
|
383
|
+
teamMember: Record<string, true | undefined>;
|
|
384
|
+
signUp: Record<string, true | undefined>;
|
|
385
|
+
};
|
|
386
|
+
};
|
|
402
387
|
emails: {
|
|
403
388
|
selectedThemeId?: string | undefined;
|
|
404
389
|
themes: Record<string, {
|
|
@@ -411,6 +396,21 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
411
396
|
tsxSource: string;
|
|
412
397
|
}>;
|
|
413
398
|
};
|
|
399
|
+
users: {
|
|
400
|
+
allowClientUserDeletion?: boolean | undefined;
|
|
401
|
+
};
|
|
402
|
+
apiKeys: {
|
|
403
|
+
enabled: {
|
|
404
|
+
team?: boolean | undefined;
|
|
405
|
+
user?: boolean | undefined;
|
|
406
|
+
};
|
|
407
|
+
};
|
|
408
|
+
apps: {
|
|
409
|
+
installed: Record<"authentication" | "fraud-protection" | "onboarding" | "teams" | "rbac" | "api-keys" | "payments" | "emails" | "support" | "email-api" | "data-vault" | "webhooks" | "tv-mode" | "launch-checklist" | "catalyst" | "neon" | "convex" | "vercel" | "tanstack-start" | "analytics" | "session-replays", {
|
|
410
|
+
enabled?: boolean | undefined;
|
|
411
|
+
}>;
|
|
412
|
+
};
|
|
413
|
+
domains: {};
|
|
414
414
|
dbSync: {
|
|
415
415
|
externalDatabases: Record<string, {
|
|
416
416
|
connectionString?: string | undefined;
|
|
@@ -422,7 +422,7 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
422
422
|
displayName?: string | undefined;
|
|
423
423
|
}>;
|
|
424
424
|
};
|
|
425
|
-
}>, "
|
|
425
|
+
}>, "auth" | "payments" | "emails" | "analytics" | "domains" | "customDashboards"> & {
|
|
426
426
|
payments?: (Omit<{
|
|
427
427
|
blockNewPurchases?: boolean | undefined;
|
|
428
428
|
autoPay?: {
|
|
@@ -465,13 +465,6 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
465
465
|
}, "testMode"> & {
|
|
466
466
|
testMode?: boolean | undefined;
|
|
467
467
|
}) | undefined;
|
|
468
|
-
domains: Omit<{}, "allowLocalhost" | "trustedDomains"> & {
|
|
469
|
-
allowLocalhost?: boolean | undefined;
|
|
470
|
-
trustedDomains: Record<string, {
|
|
471
|
-
baseUrl?: string | undefined;
|
|
472
|
-
handlerPath?: string | undefined;
|
|
473
|
-
}>;
|
|
474
|
-
};
|
|
475
468
|
auth: Omit<{
|
|
476
469
|
allowSignUp?: boolean | undefined;
|
|
477
470
|
signUpRulesDefaultAction?: string | undefined;
|
|
@@ -563,6 +556,13 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
563
556
|
}>;
|
|
564
557
|
}>;
|
|
565
558
|
};
|
|
559
|
+
domains: Omit<{}, "allowLocalhost" | "trustedDomains"> & {
|
|
560
|
+
allowLocalhost?: boolean | undefined;
|
|
561
|
+
trustedDomains: Record<string, {
|
|
562
|
+
baseUrl?: string | undefined;
|
|
563
|
+
handlerPath?: string | undefined;
|
|
564
|
+
}>;
|
|
565
|
+
};
|
|
566
566
|
customDashboards: Record<string, {
|
|
567
567
|
displayName: string;
|
|
568
568
|
tsxSource: string;
|
|
@@ -572,7 +572,7 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
572
572
|
project: {
|
|
573
573
|
requirePublishableClientKey: undefined;
|
|
574
574
|
};
|
|
575
|
-
}, string>, "
|
|
575
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
576
576
|
rbac: {
|
|
577
577
|
permissions: undefined;
|
|
578
578
|
defaultPermissions: {
|
|
@@ -639,13 +639,13 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
639
639
|
dataVault: {
|
|
640
640
|
stores: undefined;
|
|
641
641
|
};
|
|
642
|
-
}>, "
|
|
642
|
+
}>, "auth" | "payments" | "emails" | "analytics" | "domains" | "customDashboards"> & {
|
|
643
643
|
auth: Omit<NonNullable<Omit<Omit<{
|
|
644
644
|
sourceOfTruth: undefined;
|
|
645
645
|
project: {
|
|
646
646
|
requirePublishableClientKey: undefined;
|
|
647
647
|
};
|
|
648
|
-
}, string>, "
|
|
648
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
649
649
|
rbac: {
|
|
650
650
|
permissions: undefined;
|
|
651
651
|
defaultPermissions: {
|
|
@@ -718,7 +718,7 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
718
718
|
project: {
|
|
719
719
|
requirePublishableClientKey: undefined;
|
|
720
720
|
};
|
|
721
|
-
}, string>, "
|
|
721
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
722
722
|
rbac: {
|
|
723
723
|
permissions: undefined;
|
|
724
724
|
defaultPermissions: {
|
|
@@ -794,7 +794,7 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
794
794
|
project: {
|
|
795
795
|
requirePublishableClientKey: undefined;
|
|
796
796
|
};
|
|
797
|
-
}, string>, "
|
|
797
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
798
798
|
rbac: {
|
|
799
799
|
permissions: undefined;
|
|
800
800
|
defaultPermissions: {
|
|
@@ -880,7 +880,7 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
880
880
|
project: {
|
|
881
881
|
requirePublishableClientKey: undefined;
|
|
882
882
|
};
|
|
883
|
-
}, string>, "
|
|
883
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
884
884
|
rbac: {
|
|
885
885
|
permissions: undefined;
|
|
886
886
|
defaultPermissions: {
|
|
@@ -956,7 +956,7 @@ declare const environmentConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<Omit<{
|
|
|
956
956
|
project: {
|
|
957
957
|
requirePublishableClientKey: undefined;
|
|
958
958
|
};
|
|
959
|
-
}, string>, "
|
|
959
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
960
960
|
rbac: {
|
|
961
961
|
permissions: undefined;
|
|
962
962
|
defaultPermissions: {
|
|
@@ -1038,7 +1038,7 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1038
1038
|
sourceOfTruth: {
|
|
1039
1039
|
type: "hosted";
|
|
1040
1040
|
};
|
|
1041
|
-
}, string>, "
|
|
1041
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
1042
1042
|
payments?: {
|
|
1043
1043
|
blockNewPurchases?: boolean | undefined;
|
|
1044
1044
|
autoPay?: {
|
|
@@ -1079,40 +1079,6 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1079
1079
|
}>;
|
|
1080
1080
|
}>;
|
|
1081
1081
|
} | undefined;
|
|
1082
|
-
users: {
|
|
1083
|
-
allowClientUserDeletion?: boolean | undefined;
|
|
1084
|
-
};
|
|
1085
|
-
teams: {
|
|
1086
|
-
createPersonalTeamOnSignUp?: boolean | undefined;
|
|
1087
|
-
allowClientTeamCreation?: boolean | undefined;
|
|
1088
|
-
};
|
|
1089
|
-
rbac: {
|
|
1090
|
-
permissions: Record<string, {
|
|
1091
|
-
description?: string | undefined;
|
|
1092
|
-
scope?: "team" | "project" | undefined;
|
|
1093
|
-
containedPermissionIds?: Record<string, true | undefined> | undefined;
|
|
1094
|
-
} | undefined>;
|
|
1095
|
-
defaultPermissions: {
|
|
1096
|
-
teamCreator: Record<string, true | undefined>;
|
|
1097
|
-
teamMember: Record<string, true | undefined>;
|
|
1098
|
-
signUp: Record<string, true | undefined>;
|
|
1099
|
-
};
|
|
1100
|
-
};
|
|
1101
|
-
onboarding: {
|
|
1102
|
-
requireEmailVerification?: boolean | undefined;
|
|
1103
|
-
};
|
|
1104
|
-
apiKeys: {
|
|
1105
|
-
enabled: {
|
|
1106
|
-
team?: boolean | undefined;
|
|
1107
|
-
user?: boolean | undefined;
|
|
1108
|
-
};
|
|
1109
|
-
};
|
|
1110
|
-
apps: {
|
|
1111
|
-
installed: Record<"teams" | "rbac" | "onboarding" | "payments" | "authentication" | "fraud-protection" | "api-keys" | "emails" | "support" | "email-api" | "data-vault" | "webhooks" | "tv-mode" | "launch-checklist" | "catalyst" | "neon" | "convex" | "vercel" | "tanstack-start" | "analytics" | "session-replays", {
|
|
1112
|
-
enabled?: boolean | undefined;
|
|
1113
|
-
}>;
|
|
1114
|
-
};
|
|
1115
|
-
domains: {};
|
|
1116
1082
|
auth: {
|
|
1117
1083
|
allowSignUp?: boolean | undefined;
|
|
1118
1084
|
signUpRulesDefaultAction?: string | undefined;
|
|
@@ -1144,6 +1110,25 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1144
1110
|
};
|
|
1145
1111
|
}>;
|
|
1146
1112
|
};
|
|
1113
|
+
onboarding: {
|
|
1114
|
+
requireEmailVerification?: boolean | undefined;
|
|
1115
|
+
};
|
|
1116
|
+
teams: {
|
|
1117
|
+
createPersonalTeamOnSignUp?: boolean | undefined;
|
|
1118
|
+
allowClientTeamCreation?: boolean | undefined;
|
|
1119
|
+
};
|
|
1120
|
+
rbac: {
|
|
1121
|
+
permissions: Record<string, {
|
|
1122
|
+
description?: string | undefined;
|
|
1123
|
+
scope?: "team" | "project" | undefined;
|
|
1124
|
+
containedPermissionIds?: Record<string, true | undefined> | undefined;
|
|
1125
|
+
} | undefined>;
|
|
1126
|
+
defaultPermissions: {
|
|
1127
|
+
teamCreator: Record<string, true | undefined>;
|
|
1128
|
+
teamMember: Record<string, true | undefined>;
|
|
1129
|
+
signUp: Record<string, true | undefined>;
|
|
1130
|
+
};
|
|
1131
|
+
};
|
|
1147
1132
|
emails: {
|
|
1148
1133
|
selectedThemeId?: string | undefined;
|
|
1149
1134
|
themes: Record<string, {
|
|
@@ -1156,6 +1141,21 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1156
1141
|
tsxSource: string;
|
|
1157
1142
|
}>;
|
|
1158
1143
|
};
|
|
1144
|
+
users: {
|
|
1145
|
+
allowClientUserDeletion?: boolean | undefined;
|
|
1146
|
+
};
|
|
1147
|
+
apiKeys: {
|
|
1148
|
+
enabled: {
|
|
1149
|
+
team?: boolean | undefined;
|
|
1150
|
+
user?: boolean | undefined;
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1153
|
+
apps: {
|
|
1154
|
+
installed: Record<"authentication" | "fraud-protection" | "onboarding" | "teams" | "rbac" | "api-keys" | "payments" | "emails" | "support" | "email-api" | "data-vault" | "webhooks" | "tv-mode" | "launch-checklist" | "catalyst" | "neon" | "convex" | "vercel" | "tanstack-start" | "analytics" | "session-replays", {
|
|
1155
|
+
enabled?: boolean | undefined;
|
|
1156
|
+
}>;
|
|
1157
|
+
};
|
|
1158
|
+
domains: {};
|
|
1159
1159
|
dbSync: {
|
|
1160
1160
|
externalDatabases: Record<string, {
|
|
1161
1161
|
connectionString?: string | undefined;
|
|
@@ -1167,7 +1167,7 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1167
1167
|
displayName?: string | undefined;
|
|
1168
1168
|
}>;
|
|
1169
1169
|
};
|
|
1170
|
-
}>, "
|
|
1170
|
+
}>, "auth" | "payments" | "emails" | "analytics" | "domains" | "customDashboards"> & {
|
|
1171
1171
|
payments?: (Omit<{
|
|
1172
1172
|
blockNewPurchases?: boolean | undefined;
|
|
1173
1173
|
autoPay?: {
|
|
@@ -1210,13 +1210,6 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1210
1210
|
}, "testMode"> & {
|
|
1211
1211
|
testMode?: boolean | undefined;
|
|
1212
1212
|
}) | undefined;
|
|
1213
|
-
domains: Omit<{}, "allowLocalhost" | "trustedDomains"> & {
|
|
1214
|
-
allowLocalhost?: boolean | undefined;
|
|
1215
|
-
trustedDomains: Record<string, {
|
|
1216
|
-
baseUrl?: string | undefined;
|
|
1217
|
-
handlerPath?: string | undefined;
|
|
1218
|
-
}>;
|
|
1219
|
-
};
|
|
1220
1213
|
auth: Omit<{
|
|
1221
1214
|
allowSignUp?: boolean | undefined;
|
|
1222
1215
|
signUpRulesDefaultAction?: string | undefined;
|
|
@@ -1308,6 +1301,13 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1308
1301
|
}>;
|
|
1309
1302
|
}>;
|
|
1310
1303
|
};
|
|
1304
|
+
domains: Omit<{}, "allowLocalhost" | "trustedDomains"> & {
|
|
1305
|
+
allowLocalhost?: boolean | undefined;
|
|
1306
|
+
trustedDomains: Record<string, {
|
|
1307
|
+
baseUrl?: string | undefined;
|
|
1308
|
+
handlerPath?: string | undefined;
|
|
1309
|
+
}>;
|
|
1310
|
+
};
|
|
1311
1311
|
customDashboards: Record<string, {
|
|
1312
1312
|
displayName: string;
|
|
1313
1313
|
tsxSource: string;
|
|
@@ -1317,7 +1317,7 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1317
1317
|
project: {
|
|
1318
1318
|
requirePublishableClientKey: undefined;
|
|
1319
1319
|
};
|
|
1320
|
-
}, string>, "
|
|
1320
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
1321
1321
|
rbac: {
|
|
1322
1322
|
permissions: undefined;
|
|
1323
1323
|
defaultPermissions: {
|
|
@@ -1384,13 +1384,13 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1384
1384
|
dataVault: {
|
|
1385
1385
|
stores: undefined;
|
|
1386
1386
|
};
|
|
1387
|
-
}>, "
|
|
1387
|
+
}>, "auth" | "payments" | "emails" | "analytics" | "domains" | "customDashboards"> & {
|
|
1388
1388
|
auth: Omit<NonNullable<Omit<Omit<{
|
|
1389
1389
|
sourceOfTruth: undefined;
|
|
1390
1390
|
project: {
|
|
1391
1391
|
requirePublishableClientKey: undefined;
|
|
1392
1392
|
};
|
|
1393
|
-
}, string>, "
|
|
1393
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
1394
1394
|
rbac: {
|
|
1395
1395
|
permissions: undefined;
|
|
1396
1396
|
defaultPermissions: {
|
|
@@ -1463,7 +1463,7 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1463
1463
|
project: {
|
|
1464
1464
|
requirePublishableClientKey: undefined;
|
|
1465
1465
|
};
|
|
1466
|
-
}, string>, "
|
|
1466
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
1467
1467
|
rbac: {
|
|
1468
1468
|
permissions: undefined;
|
|
1469
1469
|
defaultPermissions: {
|
|
@@ -1539,7 +1539,7 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1539
1539
|
project: {
|
|
1540
1540
|
requirePublishableClientKey: undefined;
|
|
1541
1541
|
};
|
|
1542
|
-
}, string>, "
|
|
1542
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
1543
1543
|
rbac: {
|
|
1544
1544
|
permissions: undefined;
|
|
1545
1545
|
defaultPermissions: {
|
|
@@ -1625,7 +1625,7 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1625
1625
|
project: {
|
|
1626
1626
|
requirePublishableClientKey: undefined;
|
|
1627
1627
|
};
|
|
1628
|
-
}, string>, "
|
|
1628
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
1629
1629
|
rbac: {
|
|
1630
1630
|
permissions: undefined;
|
|
1631
1631
|
defaultPermissions: {
|
|
@@ -1701,7 +1701,7 @@ declare const organizationConfigSchema: yup$1.Schema<Omit<NonNullable<Omit<NonNu
|
|
|
1701
1701
|
project: {
|
|
1702
1702
|
requirePublishableClientKey: undefined;
|
|
1703
1703
|
};
|
|
1704
|
-
}, string>, "
|
|
1704
|
+
}, string>, "auth" | "onboarding" | "teams" | "rbac" | "payments" | "emails" | "users" | "apiKeys" | "apps" | "domains" | "dbSync" | "dataVault"> & {
|
|
1705
1705
|
rbac: {
|
|
1706
1706
|
permissions: undefined;
|
|
1707
1707
|
defaultPermissions: {
|
|
@@ -2174,8 +2174,8 @@ declare function sanitizeOrganizationConfig(config: OrganizationRenderedConfigBe
|
|
|
2174
2174
|
} & {
|
|
2175
2175
|
readonly type: "hosted";
|
|
2176
2176
|
};
|
|
2177
|
-
|
|
2178
|
-
|
|
2177
|
+
onboarding: {
|
|
2178
|
+
requireEmailVerification: boolean;
|
|
2179
2179
|
};
|
|
2180
2180
|
teams: {
|
|
2181
2181
|
createPersonalTeamOnSignUp: boolean;
|
|
@@ -2203,8 +2203,23 @@ declare function sanitizeOrganizationConfig(config: OrganizationRenderedConfigBe
|
|
|
2203
2203
|
};
|
|
2204
2204
|
};
|
|
2205
2205
|
};
|
|
2206
|
-
|
|
2207
|
-
|
|
2206
|
+
analytics: {
|
|
2207
|
+
queryFolders: {
|
|
2208
|
+
[x: string]: {
|
|
2209
|
+
displayName: string;
|
|
2210
|
+
sortOrder: number;
|
|
2211
|
+
queries: {
|
|
2212
|
+
[x: string]: {
|
|
2213
|
+
description: string | undefined;
|
|
2214
|
+
displayName: string;
|
|
2215
|
+
sqlQuery: string;
|
|
2216
|
+
};
|
|
2217
|
+
};
|
|
2218
|
+
};
|
|
2219
|
+
};
|
|
2220
|
+
};
|
|
2221
|
+
users: {
|
|
2222
|
+
allowClientUserDeletion: boolean;
|
|
2208
2223
|
};
|
|
2209
2224
|
apiKeys: {
|
|
2210
2225
|
enabled: {
|
|
@@ -2221,21 +2236,6 @@ declare function sanitizeOrganizationConfig(config: OrganizationRenderedConfigBe
|
|
|
2221
2236
|
};
|
|
2222
2237
|
};
|
|
2223
2238
|
};
|
|
2224
|
-
analytics: {
|
|
2225
|
-
queryFolders: {
|
|
2226
|
-
[x: string]: {
|
|
2227
|
-
displayName: string;
|
|
2228
|
-
sortOrder: number;
|
|
2229
|
-
queries: {
|
|
2230
|
-
[x: string]: {
|
|
2231
|
-
description: string | undefined;
|
|
2232
|
-
displayName: string;
|
|
2233
|
-
sqlQuery: string;
|
|
2234
|
-
};
|
|
2235
|
-
};
|
|
2236
|
-
};
|
|
2237
|
-
};
|
|
2238
|
-
};
|
|
2239
2239
|
dbSync: {
|
|
2240
2240
|
externalDatabases: {
|
|
2241
2241
|
[x: string]: {
|
|
@@ -19,6 +19,7 @@ const remindersPrompt = deindent`
|
|
|
19
19
|
- Language, framework, and library-specific details:
|
|
20
20
|
- JavaScript & TypeScript:
|
|
21
21
|
- Hexclave has different SDK packages for different frameworks and languages. As of the time of writing these reminders, they are: @hexclave/js (JavaScript/TypeScript), @hexclave/next (Next.js), @hexclave/react (React), @hexclave/tanstack-start (TanStack Start). You can find all of these on npm. They are all versioned together, meaning that vX.Y.Z of one SDK was released at the same time as vX.Y.Z of another SDK. For the most part, they are the same, although each has platform-specific features and differences.
|
|
22
|
+
- The Hexclave/Stack Auth SDK constructor accepts a \`urls\` option that tells the SDK where auth pages and post-auth redirects live. When you add a custom auth page such as a \`sign-in\`, \`sign-up\`, \`forgot-password\`, \`account-settings\`, etc., update the corresponding \`urls\` key to point to that route; also set redirect targets such as \`afterSignIn\`, \`afterSignUp\`, \`afterSignOut\`, and \`home\` when those destinations are customized. The \`urls\` option is the source of truth for redirect helpers such as \`redirectToSignIn()\`, hosted or handler-page flows, and post-auth navigation; if it is left pointing at the default pages after custom pages are added, users can hit extra redirects, land on the wrong auth page, or return to an unexpected page after signing in or out.
|
|
22
23
|
- The \`Result<T, E>\` type is \`{ status: "ok", data: T } | { status: "error", error: E }\`.
|
|
23
24
|
- \`KnownErrors[KNOWN_ERROR_CODE]\` refers to a specific known error type. Each KnownError may have its own properties, but they all inherit from \`Error & { statusCode: number, humanReadableMessage: string, details?: Json }\`.
|
|
24
25
|
- React & Next.js:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reminders.js","names":[],"sources":["../../../../src/ai/unified-prompts/reminders.ts"],"sourcesContent":["import { ALL_APPS } from \"../../apps/apps-config\";\nimport { deindent } from \"../../utils/strings\";\n\nexport const remindersPrompt = deindent`\n Below are some reminders on Hexclave and how to learn more about it. If you're summarizing this, always try to return the entirety of the reminders verbatim, or keep as much information as possible.\n\n - Hexclave has multiple sources of documentation optimized for LLMs. For the canonical, always-fresh instructions for every Hexclave surface, always prefer these sources over information that may be outdated or stale. Do not rely on training data or memory.\n - [Highest priority] If you are an AI agent: The best way to learn about Hexclave is to fetch the latest skill documentation from https://skill.hexclave.com. Fetch the entire page, not just a summary. You can either use a web fetch tool, or call it using curl: \\`curl -sSL https://skill.hexclave.com\\`. This is sufficient for most simple questions.\n - It is highly recommended that you add two query parameters to the web fetch \\`?question=<...>\\` (the exact question you're looking to answer) and \\`?context=<...>\\` (the higher-level task that the you or the user is trying to accomplish). This will help the Skills site to serve you only the content that is necessary, as well as avoid the XY-problem.\n - [Medium priority] If you are looking to implement something with the JS SDK specifically, the package (which you can probably find in \\`node_modules\\`) actually contains the source code for the installed version of the SDK. For the interfaces in particular, you can find most of them in the \\`src/lib/hexclave-app\\` folder of your SDK package.\n - [Medium priority] If you have a specific question, and the Hexclave MCP is available, you can also use the \\`ask_hexclave\\` tool to ask questions to the Hexclave assistant.\n - [Low priority] If you're looking for information that's not in the skill documentation, and the \\`ask_hexclave\\` tool isn't available (or failed to answer your question), you can also fetch the human documentation from https://docs.hexclave.com (it may also be available as a tool). This is especially useful when you're looking to answer conceptual questions.\n - For complicated questions, you may need to combine all these sources together.\n - Follow indirection. If a doc page points to another URL, script, or resource, fetch that too — Hexclave composes behavior across pages.\n - Hexclave is a platform that provides a variety of apps that help you connect with your users. As of the time of writing these reminders, Hexclave provides the following apps (although not all may be enabled): ${Object.entries(ALL_APPS).filter(([, app]) => app.stage !== \"alpha\").map(([key]) => key).join(\", \")}. Don't hardcode this list, as it changes rapidly.\n - The most important object in Hexclave is the Hexclave App object. HexclaveClientApp provides client-side functionality, while HexclaveServerApp also provides server-side functionality (but can usually only be imported on the server, as it requires a secret server key environment variable). You can usually find an instance of this object in a file called \\`hexclave/client.tsx\\` or \\`hexclave/server.tsx\\`, although it may be in a different location in this particular codebase.\n - Take extra care to always have great error handling and loading states whenever necessary (including in button onClick handlers; Hexclave's code examples often use a special onClick class which handles loading states, but your own button may not). Hexclave's SDK tends to return errors that need to be handled explicitly in its return types.\n - Language, framework, and library-specific details:\n - JavaScript & TypeScript:\n - Hexclave has different SDK packages for different frameworks and languages. As of the time of writing these reminders, they are: @hexclave/js (JavaScript/TypeScript), @hexclave/next (Next.js), @hexclave/react (React), @hexclave/tanstack-start (TanStack Start). You can find all of these on npm. They are all versioned together, meaning that vX.Y.Z of one SDK was released at the same time as vX.Y.Z of another SDK. For the most part, they are the same, although each has platform-specific features and differences.\n - The \\`Result<T, E>\\` type is \\`{ status: \"ok\", data: T } | { status: \"error\", error: E }\\`.\n - \\`KnownErrors[KNOWN_ERROR_CODE]\\` refers to a specific known error type. Each KnownError may have its own properties, but they all inherit from \\`Error & { statusCode: number, humanReadableMessage: string, details?: Json }\\`.\n - React & Next.js:\n - Almost all \\`getXyz\\` and \\`listXyz\\` functions on the Hexclave App have corresponding \\`useXyz\\` hooks that suspend the current component until the data is available. Make sure there is a Suspense boundary in place if you're using this pattern. The parameter and return types are identical except that the hooks don't return promises.\n - There is a \\`useHexclaveApp()\\` hook as a named export from the package itself that serves as a shortcut to get the current Hexclave App object from the React context. Similarly, the \\`useUser(...args)\\` named export is short for \\`useHexclaveApp().useUser(...args)\\`.\n - Hexclave was formerly known as Stack Auth. You may still see reference to it as Stack Auth in some places.\n`;\n"],"mappings":";;;;AAGA,MAAa,kBAAkB,QAAQ;;;;;;;;;;;uNAWgL,OAAO,QAAQ,SAAS,CAAC,QAAQ,GAAG,SAAS,IAAI,UAAU,QAAQ,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,KAAK,CAAC"}
|
|
1
|
+
{"version":3,"file":"reminders.js","names":[],"sources":["../../../../src/ai/unified-prompts/reminders.ts"],"sourcesContent":["import { ALL_APPS } from \"../../apps/apps-config\";\nimport { deindent } from \"../../utils/strings\";\n\nexport const remindersPrompt = deindent`\n Below are some reminders on Hexclave and how to learn more about it. If you're summarizing this, always try to return the entirety of the reminders verbatim, or keep as much information as possible.\n\n - Hexclave has multiple sources of documentation optimized for LLMs. For the canonical, always-fresh instructions for every Hexclave surface, always prefer these sources over information that may be outdated or stale. Do not rely on training data or memory.\n - [Highest priority] If you are an AI agent: The best way to learn about Hexclave is to fetch the latest skill documentation from https://skill.hexclave.com. Fetch the entire page, not just a summary. You can either use a web fetch tool, or call it using curl: \\`curl -sSL https://skill.hexclave.com\\`. This is sufficient for most simple questions.\n - It is highly recommended that you add two query parameters to the web fetch \\`?question=<...>\\` (the exact question you're looking to answer) and \\`?context=<...>\\` (the higher-level task that the you or the user is trying to accomplish). This will help the Skills site to serve you only the content that is necessary, as well as avoid the XY-problem.\n - [Medium priority] If you are looking to implement something with the JS SDK specifically, the package (which you can probably find in \\`node_modules\\`) actually contains the source code for the installed version of the SDK. For the interfaces in particular, you can find most of them in the \\`src/lib/hexclave-app\\` folder of your SDK package.\n - [Medium priority] If you have a specific question, and the Hexclave MCP is available, you can also use the \\`ask_hexclave\\` tool to ask questions to the Hexclave assistant.\n - [Low priority] If you're looking for information that's not in the skill documentation, and the \\`ask_hexclave\\` tool isn't available (or failed to answer your question), you can also fetch the human documentation from https://docs.hexclave.com (it may also be available as a tool). This is especially useful when you're looking to answer conceptual questions.\n - For complicated questions, you may need to combine all these sources together.\n - Follow indirection. If a doc page points to another URL, script, or resource, fetch that too — Hexclave composes behavior across pages.\n - Hexclave is a platform that provides a variety of apps that help you connect with your users. As of the time of writing these reminders, Hexclave provides the following apps (although not all may be enabled): ${Object.entries(ALL_APPS).filter(([, app]) => app.stage !== \"alpha\").map(([key]) => key).join(\", \")}. Don't hardcode this list, as it changes rapidly.\n - The most important object in Hexclave is the Hexclave App object. HexclaveClientApp provides client-side functionality, while HexclaveServerApp also provides server-side functionality (but can usually only be imported on the server, as it requires a secret server key environment variable). You can usually find an instance of this object in a file called \\`hexclave/client.tsx\\` or \\`hexclave/server.tsx\\`, although it may be in a different location in this particular codebase.\n - Take extra care to always have great error handling and loading states whenever necessary (including in button onClick handlers; Hexclave's code examples often use a special onClick class which handles loading states, but your own button may not). Hexclave's SDK tends to return errors that need to be handled explicitly in its return types.\n - Language, framework, and library-specific details:\n - JavaScript & TypeScript:\n - Hexclave has different SDK packages for different frameworks and languages. As of the time of writing these reminders, they are: @hexclave/js (JavaScript/TypeScript), @hexclave/next (Next.js), @hexclave/react (React), @hexclave/tanstack-start (TanStack Start). You can find all of these on npm. They are all versioned together, meaning that vX.Y.Z of one SDK was released at the same time as vX.Y.Z of another SDK. For the most part, they are the same, although each has platform-specific features and differences.\n - The Hexclave/Stack Auth SDK constructor accepts a \\`urls\\` option that tells the SDK where auth pages and post-auth redirects live. When you add a custom auth page such as a \\`sign-in\\`, \\`sign-up\\`, \\`forgot-password\\`, \\`account-settings\\`, etc., update the corresponding \\`urls\\` key to point to that route; also set redirect targets such as \\`afterSignIn\\`, \\`afterSignUp\\`, \\`afterSignOut\\`, and \\`home\\` when those destinations are customized. The \\`urls\\` option is the source of truth for redirect helpers such as \\`redirectToSignIn()\\`, hosted or handler-page flows, and post-auth navigation; if it is left pointing at the default pages after custom pages are added, users can hit extra redirects, land on the wrong auth page, or return to an unexpected page after signing in or out.\n - The \\`Result<T, E>\\` type is \\`{ status: \"ok\", data: T } | { status: \"error\", error: E }\\`.\n - \\`KnownErrors[KNOWN_ERROR_CODE]\\` refers to a specific known error type. Each KnownError may have its own properties, but they all inherit from \\`Error & { statusCode: number, humanReadableMessage: string, details?: Json }\\`.\n - React & Next.js:\n - Almost all \\`getXyz\\` and \\`listXyz\\` functions on the Hexclave App have corresponding \\`useXyz\\` hooks that suspend the current component until the data is available. Make sure there is a Suspense boundary in place if you're using this pattern. The parameter and return types are identical except that the hooks don't return promises.\n - There is a \\`useHexclaveApp()\\` hook as a named export from the package itself that serves as a shortcut to get the current Hexclave App object from the React context. Similarly, the \\`useUser(...args)\\` named export is short for \\`useHexclaveApp().useUser(...args)\\`.\n - Hexclave was formerly known as Stack Auth. You may still see reference to it as Stack Auth in some places.\n`;\n"],"mappings":";;;;AAGA,MAAa,kBAAkB,QAAQ;;;;;;;;;;;uNAWgL,OAAO,QAAQ,SAAS,CAAC,QAAQ,GAAG,SAAS,IAAI,UAAU,QAAQ,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,KAAK,CAAC"}
|