@stackframe/stack-shared 2.4.10 → 2.4.13

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @stackframe/stack-shared
 
+## 2.4.13
+
+### Patch Changes
+
+- Improve setup flow
+- Updated dependencies
+  - @stackframe/stack-sc@1.5.6
+
+## 2.4.12
+
+### Patch Changes
+
+- Improved client styling, added login form, added spotify oauth
+
+## 2.4.11
+
+### Patch Changes
+
+- Added email editor
+
 ## 2.4.10
 
 ### Patch Changes

package/dist/interface/clientInterface.d.ts

@@ -47,10 +47,10 @@ export type ClientInterfaceOptions = {
     projectOwnerTokens: TokenStore;
     refreshProjectOwnerTokens: () => Promise<void>;
 });
-export type SharedProvider = "shared-github" | "shared-google" | "shared-facebook" | "shared-microsoft";
-export declare const sharedProviders: readonly ["shared-github", "shared-google", "shared-facebook", "shared-microsoft"];
-export type StandardProvider = "github" | "facebook" | "google" | "microsoft";
-export declare const standardProviders: readonly ["github", "facebook", "google", "microsoft"];
+export type SharedProvider = "shared-github" | "shared-google" | "shared-facebook" | "shared-microsoft" | "shared-spotify";
+export declare const sharedProviders: readonly ["shared-github", "shared-google", "shared-facebook", "shared-microsoft", "shared-spotify"];
+export type StandardProvider = "github" | "facebook" | "google" | "microsoft" | "spotify";
+export declare const standardProviders: readonly ["github", "facebook", "google", "microsoft", "spotify"];
 export declare function toStandardProvider(provider: SharedProvider | StandardProvider): StandardProvider;
 export declare function toSharedProvider(provider: SharedProvider | StandardProvider): SharedProvider;
 export type ReadonlyTokenStore = ReadonlyAsyncStore<TokenObject>;

package/dist/interface/clientInterface.js

@@ -10,12 +10,14 @@ export const sharedProviders = [
     "shared-google",
     "shared-facebook",
     "shared-microsoft",
+    "shared-spotify",
 ];
 export const standardProviders = [
     "github",
     "facebook",
     "google",
     "microsoft",
+    "spotify",
 ];
 export function toStandardProvider(provider) {
     return provider.replace("shared-", "");

package/dist/interface/crud/email-templates.d.ts

@@ -0,0 +1,119 @@
+import { CrudTypeOf } from "../../crud";
+import * as yup from "yup";
+export declare const emailTemplateServerReadSchema: yup.ObjectSchema<{
+    type: NonNullable<"EMAIL_VERIFICATION" | "PASSWORD_RESET" | "MAGIC_LINK" | undefined>;
+    subject: string;
+    content: {};
+}, yup.AnyObject, {
+    type: undefined;
+    subject: undefined;
+    content: undefined;
+}, "">;
+export declare const emailTemplateCrudServerUpdateSchema: yup.ObjectSchema<{
+    content: {};
+    subject: string;
+}, yup.AnyObject, {
+    content: undefined;
+    subject: undefined;
+}, "">;
+export declare const emailTemplateCrud: {
+    client: {
+        createSchema: undefined;
+        readSchema: undefined;
+        updateSchema: undefined;
+        deleteSchema: undefined;
+    };
+    server: {
+        createSchema: undefined;
+        readSchema: yup.ObjectSchema<{
+            type: NonNullable<"EMAIL_VERIFICATION" | "PASSWORD_RESET" | "MAGIC_LINK" | undefined>;
+            subject: string;
+            content: {};
+        }, yup.AnyObject, {
+            type: undefined;
+            subject: undefined;
+            content: undefined;
+        }, "">;
+        updateSchema: yup.ObjectSchema<{
+            content: {};
+            subject: string;
+        }, yup.AnyObject, {
+            content: undefined;
+            subject: undefined;
+        }, "">;
+        deleteSchema: yup.MixedSchema<{} | undefined, yup.AnyObject, undefined, "">;
+    };
+    admin: {
+        createSchema: undefined;
+        readSchema: yup.ObjectSchema<{
+            type: NonNullable<"EMAIL_VERIFICATION" | "PASSWORD_RESET" | "MAGIC_LINK" | undefined>;
+            subject: string;
+            content: {};
+        }, yup.AnyObject, {
+            type: undefined;
+            subject: undefined;
+            content: undefined;
+        }, "">;
+        updateSchema: yup.ObjectSchema<{
+            content: {};
+            subject: string;
+        }, yup.AnyObject, {
+            content: undefined;
+            subject: undefined;
+        }, "">;
+        deleteSchema: yup.MixedSchema<{} | undefined, yup.AnyObject, undefined, "">;
+    };
+    hasCreate: boolean;
+    hasRead: boolean;
+    hasUpdate: boolean;
+    hasDelete: boolean;
+};
+export type EmailTemplateCrud = CrudTypeOf<typeof emailTemplateCrud>;
+export declare const listEmailTemplatesReadSchema: yup.ArraySchema<{
+    type: NonNullable<"EMAIL_VERIFICATION" | "PASSWORD_RESET" | "MAGIC_LINK" | undefined>;
+    default: NonNullable<boolean | undefined>;
+    subject: string;
+    content: {};
+}[], yup.AnyObject, "", "">;
+export declare const emailTemplateCrudServerCreateSchema: yup.ObjectSchema<{
+    type: NonNullable<"EMAIL_VERIFICATION" | "PASSWORD_RESET" | "MAGIC_LINK" | undefined>;
+    content: {};
+}, yup.AnyObject, {
+    type: undefined;
+    content: undefined;
+}, "">;
+export declare const listEmailTemplatesCrud: {
+    client: {
+        createSchema: undefined;
+        readSchema: undefined;
+        updateSchema: undefined;
+        deleteSchema: undefined;
+    };
+    server: {
+        createSchema: undefined;
+        readSchema: yup.ArraySchema<{
+            type: NonNullable<"EMAIL_VERIFICATION" | "PASSWORD_RESET" | "MAGIC_LINK" | undefined>;
+            default: NonNullable<boolean | undefined>;
+            subject: string;
+            content: {};
+        }[], yup.AnyObject, "", "">;
+        updateSchema: undefined;
+        deleteSchema: undefined;
+    };
+    admin: {
+        createSchema: undefined;
+        readSchema: yup.ArraySchema<{
+            type: NonNullable<"EMAIL_VERIFICATION" | "PASSWORD_RESET" | "MAGIC_LINK" | undefined>;
+            default: NonNullable<boolean | undefined>;
+            subject: string;
+            content: {};
+        }[], yup.AnyObject, "", "">;
+        updateSchema: undefined;
+        deleteSchema: undefined;
+    };
+    hasCreate: boolean;
+    hasRead: boolean;
+    hasUpdate: boolean;
+    hasDelete: boolean;
+};
+export type ListEmailTemplatesCrud = CrudTypeOf<typeof listEmailTemplatesCrud>;

package/dist/interface/crud/email-templates.js

@@ -0,0 +1,29 @@
+import { createCrud } from "../../crud";
+import * as yup from "yup";
+import { emailTemplateTypes } from "../serverInterface";
+import { yupJson } from "../../utils/yup";
+export const emailTemplateServerReadSchema = yup.object({
+    type: yup.string().oneOf(emailTemplateTypes).required(),
+    subject: yup.string().required(),
+    content: yupJson.required(),
+}).required();
+export const emailTemplateCrudServerUpdateSchema = yup.object({
+    content: yupJson.required(),
+    subject: yup.string().required(),
+}).required();
+const serverDeleteSchema = yup.mixed();
+export const emailTemplateCrud = createCrud({
+    serverReadSchema: emailTemplateServerReadSchema,
+    serverUpdateSchema: emailTemplateCrudServerUpdateSchema,
+    serverDeleteSchema,
+});
+export const listEmailTemplatesReadSchema = yup.array().of(emailTemplateServerReadSchema.concat(yup.object({
+    default: yup.boolean().required(),
+}))).required();
+export const emailTemplateCrudServerCreateSchema = yup.object({
+    type: yup.string().oneOf(emailTemplateTypes).required(),
+    content: yupJson.required(),
+}).required();
+export const listEmailTemplatesCrud = createCrud({
+    serverReadSchema: listEmailTemplatesReadSchema,
+});

package/dist/interface/serverInterface.d.ts

@@ -1,6 +1,7 @@
 import { ClientInterfaceOptions, UserJson, TokenStore, StackClientInterface, ReadonlyTokenStore, OrglikeJson, UserUpdateJson, PermissionDefinitionJson, PermissionDefinitionScopeJson as PermissionDefinitionScopeJson, TeamMemberJson } from "./clientInterface";
 import { Result } from "../utils/results";
 import { ReadonlyJson } from "../utils/json";
+import { EmailTemplateCrud, ListEmailTemplatesCrud } from "./crud/email-templates";
 export type ServerUserJson = UserJson & {
     serverMetadata: ReadonlyJson;
 };
@@ -29,6 +30,8 @@ export type ServerAuthApplicationOptions = (ClientInterfaceOptions & ({
 } | {
     readonly projectOwnerTokens: ReadonlyTokenStore;
 }));
+export declare const emailTemplateTypes: readonly ["EMAIL_VERIFICATION", "PASSWORD_RESET", "MAGIC_LINK"];
+export type EmailTemplateType = typeof emailTemplateTypes[number];
 export declare class StackServerInterface extends StackClientInterface {
     options: ServerAuthApplicationOptions;
     constructor(options: ServerAuthApplicationOptions);
@@ -74,4 +77,7 @@ export declare class StackServerInterface extends StackClientInterface {
     grantTeamUserPermission(teamId: string, userId: string, permissionId: string, type: 'global' | 'team'): Promise<void>;
     revokeTeamUserPermission(teamId: string, userId: string, permissionId: string, type: 'global' | 'team'): Promise<void>;
     deleteServerUser(userId: string): Promise<void>;
+    listEmailTemplates(): Promise<ListEmailTemplatesCrud['Server']['Read']>;
+    updateEmailTemplate(type: EmailTemplateType, data: EmailTemplateCrud['Server']['Update']): Promise<void>;
+    resetEmailTemplate(type: EmailTemplateType): Promise<void>;
 }

package/dist/interface/serverInterface.js

@@ -1,5 +1,6 @@
 import { StackClientInterface, } from "./clientInterface";
 import { Result } from "../utils/results";
+export const emailTemplateTypes = ['EMAIL_VERIFICATION', 'PASSWORD_RESET', 'MAGIC_LINK'];
 export class StackServerInterface extends StackClientInterface {
     options;
     constructor(options) {
@@ -163,4 +164,20 @@ export class StackServerInterface extends StackClientInterface {
             body: JSON.stringify({}),
         }, null);
     }
+    async listEmailTemplates() {
+        const response = await this.sendServerRequest(`/email-templates?server=true`, {}, null);
+        return await response.json();
+    }
+    async updateEmailTemplate(type, data) {
+        await this.sendServerRequest(`/email-templates/${type}?server=true`, {
+            method: "PUT",
+            headers: {
+                "content-type": "application/json",
+            },
+            body: JSON.stringify(data),
+        }, null);
+    }
+    async resetEmailTemplate(type) {
+        await this.sendServerRequest(`/email-templates/${type}?server=true`, { method: "DELETE" }, null);
+    }
 }

package/dist/known-errors.d.ts

@@ -239,5 +239,8 @@ export declare const KnownErrors: {
     TeamNotFound: KnownErrorConstructor<KnownError & KnownErrorBrand<"TEAM_NOT_FOUND">, [teamId: string]> & {
         errorCode: "TEAM_NOT_FOUND";
     };
+    EmailTemplateAlreadyExists: KnownErrorConstructor<KnownError & KnownErrorBrand<"EMAIL_TEMPLATE_ALREADY_EXISTS">, []> & {
+        errorCode: "EMAIL_TEMPLATE_ALREADY_EXISTS";
+    };
 };
 export {};

package/dist/known-errors.js

@@ -337,6 +337,10 @@ const TeamNotFound = createKnownErrorConstructor(KnownError, "TEAM_NOT_FOUND", (
         teamId,
     },
 ], (json) => [json.details.teamId]);
+const EmailTemplateAlreadyExists = createKnownErrorConstructor(KnownError, "EMAIL_TEMPLATE_ALREADY_EXISTS", () => [
+    400,
+    "Email template already exists.",
+], () => []);
 export const KnownErrors = {
     UnsupportedError,
     BodyParsingError,
@@ -403,6 +407,7 @@ export const KnownErrors = {
     PermissionNotFound,
     PermissionScopeMismatch,
     TeamNotFound,
+    EmailTemplateAlreadyExists,
 };
 // ensure that all known error codes are unique
 const knownErrorCodes = new Set();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackframe/stack-shared",
-  "version": "2.4.10",
+  "version": "2.4.13",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -26,9 +26,10 @@
     "jose": "^5.2.2",
     "oauth4webapi": "^2.10.3",
     "uuid": "^9.0.1",
-    "@stackframe/stack-sc": "1.5.5"
+    "@stackframe/stack-sc": "1.5.6"
   },
   "devDependencies": {
+    "rimraf": "^5.0.5",
     "@types/bcrypt": "^5.0.2",
     "@types/react": "^18.2.66",
     "@types/uuid": "^9.0.8"