@casual-simulation/aux-records 3.2.1 → 3.2.2-alpha.5685728183

package/AIChatInterface.d.ts

@@ -0,0 +1,127 @@
+import { z } from 'zod';
+/**
+ * Defines an interface that is able to send and receive AI chat messages.
+ */
+export interface AIChatInterface {
+    /**
+     * Sends a chat request to the AI API.
+     * @param request The request to send.
+     */
+    chat(request: AIChatInterfaceRequest): Promise<AIChatInterfaceResponse>;
+}
+/**
+ * Defines an interface that represents an AI chat request.
+ */
+export interface AIChatInterfaceRequest {
+    /**
+     * The model that should be used.
+     */
+    model: string;
+    /**
+     * The messages that should be sent to the AI.
+     */
+    messages: AIChatMessage[];
+    /**
+     * The temperature of the request.
+     */
+    temperature: number;
+    /**
+     * The nucleus sampling probability.
+     */
+    topP?: number;
+    /**
+     * The presence penalty.
+     *
+     * Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
+     */
+    presencePenalty?: number;
+    /**
+     * The frequency penalty.
+     *
+     * Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
+     */
+    frequencyPenalty?: number;
+    /**
+     * The list of stop words that should be used.
+     *
+     * If the AI generates a sequence of tokens that match one of the given words, then it will stop generating tokens.
+     */
+    stopWords?: string[];
+    /**
+     * The ID of the user that is making the request.
+     */
+    userId: string;
+}
+/**
+ * Defines an interface that represents an AI chat response.
+ */
+export interface AIChatInterfaceResponse {
+    /**
+     * The messages that the AI responded with.
+     */
+    choices: AIChatMessage[];
+}
+/**
+ * Defines an interface that represents a single chat message in a conversation with an AI.
+ *
+ * @dochash types/ai
+ * @docname AIChatMessage
+ */
+export interface AIChatMessage {
+    /**
+     * The role of the message.
+     *
+     * - `system` means that the message was generated by the system. Useful for telling the AI how to behave while.
+     * - `user` means that the message was generated by the user.
+     * - `assistant` means that the message was generated by the AI assistant.
+     * - `function` means that the message contains the results of a function call.
+     */
+    role: 'system' | 'user' | 'assistant' | 'function';
+    /**
+     * The contents of the message.
+     */
+    content: string;
+    /**
+     * The name of the author of the message.
+     *
+     * This is required if the role is `function`.
+     */
+    author?: string;
+    /**
+     * The reason why the message was finished.
+     */
+    finishReason?: string;
+    /**
+     * @hidden
+     */
+    functionCall?: AIFunctionCall;
+}
+/**
+ * Defines a schema that represents an AI chat message.
+ */
+export declare const AI_CHAT_MESSAGE_SCHEMA: z.ZodObject<{
+    role: z.ZodUnion<[z.ZodLiteral<"system">, z.ZodLiteral<"user">, z.ZodLiteral<"assistant">, z.ZodLiteral<"function">]>;
+    content: z.ZodString;
+    author: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    role?: "function" | "system" | "user" | "assistant";
+    content?: string;
+    author?: string;
+}, {
+    role?: "function" | "system" | "user" | "assistant";
+    content?: string;
+    author?: string;
+}>;
+/**
+ * Defines an interface that represents an AI function call.
+ */
+export interface AIFunctionCall {
+    name: string;
+    /**
+     * The arguments that should be passed to the function.
+     */
+    arguments: {
+        [key: string]: any;
+    };
+}
+//# sourceMappingURL=AIChatInterface.d.ts.map

package/AIChatInterface.js

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+/**
+ * Defines a schema that represents an AI chat message.
+ */
+export const AI_CHAT_MESSAGE_SCHEMA = z.object({
+    role: z.union([
+        z.literal('system'),
+        z.literal('user'),
+        z.literal('assistant'),
+        z.literal('function'),
+    ]),
+    content: z.string().nonempty(),
+    author: z.string().nonempty().optional(),
+});
+//# sourceMappingURL=AIChatInterface.js.map

package/AIChatInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AIChatInterface.js","sourceRoot":"","sources":["AIChatInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAkHxB;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC;QACV,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACnB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACjB,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QACtB,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;KACxB,CAAC;IACF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC"}

package/AIController.d.ts

@@ -0,0 +1,153 @@
+import { InvalidSubscriptionTierError, NotLoggedInError, NotSubscribedError, NotSupportedError, ServerError } from './Errors';
+import { AIChatInterface, AIChatMessage } from './AIChatInterface';
+import { AIGenerateSkyboxInterface, AIGenerateSkyboxInterfaceBlockadeLabsOptions } from './AIGenerateSkyboxInterface';
+export interface AIConfiguration {
+    chat: AIChatConfiguration | null;
+    generateSkybox: AIGenerateSkyboxConfiguration | null;
+}
+export interface AIChatConfiguration {
+    interface: AIChatInterface;
+    options: AIChatOptions;
+}
+export interface AIChatOptions {
+    /**
+     * The model that should be used when none is specified in a request.
+     */
+    defaultModel: string;
+    /**
+     * The list of allowed models that are allowed to be used for chat.
+     */
+    allowedChatModels: string[];
+    /**
+     * The list of subscription tiers that are allowed to be used for chat.
+     *
+     * - `true` indicates that all users are allowed, regardless of their subscription tier or if they are even subscribed.
+     * - An array of strings indicates that only users with the given subscription tiers are allowed.
+     */
+    allowedChatSubscriptionTiers: true | string[];
+}
+export interface AIGenerateSkyboxConfiguration {
+    interface: AIGenerateSkyboxInterface;
+    options: AIGenerateSkyboxOptions;
+}
+export interface AIGenerateSkyboxOptions {
+    /**
+     * The list of subscription tiers that are allowed to be used for generate skybox.
+     *
+     * - `true` indicates that all users are allowed, regardless of their subscription tier or if they are even subscribed.
+     * - An array of strings indicates that only users with the given subscription tiers are allowed.
+     */
+    allowedSubscriptionTiers: true | string[];
+}
+/**
+ * Defines a class that is able to handle AI requests.
+ */
+export declare class AIController {
+    private _chat;
+    private _chatOptions;
+    private _generateSkybox;
+    private _allowedChatModels;
+    private _allowedChatSubscriptionTiers;
+    private _allowedGenerateSkyboxSubscriptionTiers;
+    constructor(configuration: AIConfiguration);
+    chat(request: AIChatRequest): Promise<AIChatResponse>;
+    generateSkybox(request: AIGenerateSkyboxRequest): Promise<AIGenerateSkyboxResponse>;
+    private _matchesSubscriptionTiers;
+}
+/**
+ * Defines an AI Chat request.
+ */
+export interface AIChatRequest {
+    /**
+     * The messages to include in the request.
+     */
+    messages: AIChatMessage[];
+    /**
+     * The model that should be used.
+     */
+    model?: string;
+    /**
+     * The ID of the currently logged in user.
+     */
+    userId: string;
+    /**
+     * The subscription tier of the user.
+     * Should be null if the user is not logged in or if they do not have a subscription.
+     */
+    userSubscriptionTier: string;
+    /**
+     * The temperature of the request.
+     */
+    temperature?: number;
+    /**
+     * The nucleus sampling probability.
+     */
+    topP?: number;
+    /**
+     * The presence penalty.
+     *
+     * Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
+     */
+    presencePenalty?: number;
+    /**
+     * The frequency penalty.
+     *
+     * Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
+     */
+    frequencyPenalty?: number;
+    /**
+     * The list of stop words that should be used.
+     *
+     * If the AI generates a sequence of tokens that match one of the given words, then it will stop generating tokens.
+     */
+    stopWords?: string[];
+}
+export type AIChatResponse = AIChatSuccess | AIChatFailure;
+export interface AIChatSuccess {
+    success: true;
+    choices: AIChatMessage[];
+}
+export interface AIChatFailure {
+    success: false;
+    errorCode: ServerError | NotLoggedInError | NotSubscribedError | InvalidSubscriptionTierError | NotSupportedError | 'invalid_model';
+    errorMessage: string;
+    allowedSubscriptionTiers?: string[];
+    currentSubscriptionTier?: string;
+}
+export interface AIGenerateSkyboxRequest {
+    /**
+     * The prompt that should be used to generate the skybox.
+     */
+    prompt: string;
+    /**
+     * The ID of the user that is currently logged in.
+     */
+    userId: string;
+    /**
+     * The subscription tier of the user.
+     * Should be null if the user is not logged in or if they do not have a subscription.
+     */
+    userSubscriptionTier: string;
+    /**
+     * The negative prompt for the skybox.
+     */
+    negativePrompt?: string;
+    /**
+     * Options specific to blockade labs.
+     */
+    blockadeLabs?: AIGenerateSkyboxInterfaceBlockadeLabsOptions;
+}
+export type AIGenerateSkyboxResponse = AIGenerateSkyboxSuccess | AIGenerateSkyboxFailure;
+export interface AIGenerateSkyboxSuccess {
+    success: true;
+    fileUrl: string;
+    thumbnailUrl: string;
+}
+export interface AIGenerateSkyboxFailure {
+    success: false;
+    errorCode: ServerError | NotLoggedInError | NotSubscribedError | InvalidSubscriptionTierError | NotSupportedError;
+    errorMessage: string;
+    allowedSubscriptionTiers?: string[];
+    currentSubscriptionTier?: string;
+}
+//# sourceMappingURL=AIController.d.ts.map

package/AIController.js

@@ -0,0 +1,183 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Defines a class that is able to handle AI requests.
+ */
+export class AIController {
+    constructor(configuration) {
+        if (configuration.chat) {
+            const chat = configuration.chat;
+            const options = chat.options;
+            this._chat = chat.interface;
+            this._chatOptions = options;
+            this._allowedChatModels = new Set(options.allowedChatModels);
+            this._allowedChatSubscriptionTiers =
+                typeof options.allowedChatSubscriptionTiers === 'boolean'
+                    ? options.allowedChatSubscriptionTiers
+                    : new Set(options.allowedChatSubscriptionTiers);
+        }
+        if (configuration.generateSkybox) {
+            this._generateSkybox = configuration.generateSkybox.interface;
+            const options = configuration.generateSkybox.options;
+            this._allowedGenerateSkyboxSubscriptionTiers =
+                typeof options.allowedSubscriptionTiers === 'boolean'
+                    ? options.allowedSubscriptionTiers
+                    : new Set(options.allowedSubscriptionTiers);
+        }
+    }
+    chat(request) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!this._chat) {
+                    return {
+                        success: false,
+                        errorCode: 'not_supported',
+                        errorMessage: 'This operation is not supported.',
+                    };
+                }
+                if (!request.userId) {
+                    return {
+                        success: false,
+                        errorCode: 'not_logged_in',
+                        errorMessage: 'The user must be logged in. Please provide a sessionKey or a recordKey.',
+                    };
+                }
+                if (!this._matchesSubscriptionTiers(request.userSubscriptionTier, this._allowedChatSubscriptionTiers)) {
+                    if (!request.userSubscriptionTier) {
+                        return {
+                            success: false,
+                            errorCode: 'not_subscribed',
+                            errorMessage: 'The user must be subscribed in order to use this operation.',
+                            allowedSubscriptionTiers: [
+                                ...this
+                                    ._allowedChatSubscriptionTiers,
+                            ],
+                        };
+                    }
+                    else {
+                        return {
+                            success: false,
+                            errorCode: 'invalid_subscription_tier',
+                            errorMessage: 'This operation is not available to the user at their current subscription tier.',
+                            allowedSubscriptionTiers: [
+                                ...this
+                                    ._allowedChatSubscriptionTiers,
+                            ],
+                            currentSubscriptionTier: request.userSubscriptionTier,
+                        };
+                    }
+                }
+                if (!!request.model &&
+                    !this._allowedChatModels.has(request.model)) {
+                    return {
+                        success: false,
+                        errorCode: 'invalid_model',
+                        errorMessage: `The given model is not allowed for chats.`,
+                    };
+                }
+                const result = yield this._chat.chat({
+                    messages: request.messages,
+                    model: (_a = request.model) !== null && _a !== void 0 ? _a : this._chatOptions.defaultModel,
+                    temperature: request.temperature,
+                    topP: request.topP,
+                    frequencyPenalty: request.frequencyPenalty,
+                    presencePenalty: request.presencePenalty,
+                    stopWords: request.stopWords,
+                    userId: request.userId,
+                });
+                return {
+                    success: true,
+                    choices: result.choices,
+                };
+            }
+            catch (err) {
+                console.error('[AIController] Error handling chat request:', err);
+                return {
+                    success: false,
+                    errorCode: 'server_error',
+                    errorMessage: 'A server error occurred.',
+                };
+            }
+        });
+    }
+    generateSkybox(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!this._generateSkybox) {
+                    return {
+                        success: false,
+                        errorCode: 'not_supported',
+                        errorMessage: 'This operation is not supported.',
+                    };
+                }
+                if (!request.userId) {
+                    return {
+                        success: false,
+                        errorCode: 'not_logged_in',
+                        errorMessage: 'The user must be logged in. Please provide a sessionKey or a recordKey.',
+                    };
+                }
+                if (!this._matchesSubscriptionTiers(request.userSubscriptionTier, this._allowedGenerateSkyboxSubscriptionTiers)) {
+                    if (!request.userSubscriptionTier) {
+                        return {
+                            success: false,
+                            errorCode: 'not_subscribed',
+                            errorMessage: 'The user must be subscribed in order to use this operation.',
+                            allowedSubscriptionTiers: [
+                                ...this
+                                    ._allowedGenerateSkyboxSubscriptionTiers,
+                            ],
+                        };
+                    }
+                    else {
+                        return {
+                            success: false,
+                            errorCode: 'invalid_subscription_tier',
+                            errorMessage: 'This operation is not available to the user at their current subscription tier.',
+                            allowedSubscriptionTiers: [
+                                ...this
+                                    ._allowedGenerateSkyboxSubscriptionTiers,
+                            ],
+                            currentSubscriptionTier: request.userSubscriptionTier,
+                        };
+                    }
+                }
+                const result = yield this._generateSkybox.generateSkybox({
+                    prompt: request.prompt,
+                    negativePrompt: request.negativePrompt,
+                    blockadeLabs: request.blockadeLabs,
+                });
+                if (result.success === true) {
+                    return {
+                        success: true,
+                        fileUrl: result.fileUrl,
+                        thumbnailUrl: result.thumbnailUrl,
+                    };
+                }
+                else {
+                    return result;
+                }
+            }
+            catch (err) {
+                console.error('[AIController] Error handling generate skybox request:', err);
+                return {
+                    success: false,
+                    errorCode: 'server_error',
+                    errorMessage: 'A server error occurred.',
+                };
+            }
+        });
+    }
+    _matchesSubscriptionTiers(tier, allowedTiers) {
+        return allowedTiers === true || allowedTiers.has(tier);
+    }
+}
+//# sourceMappingURL=AIController.js.map

package/AIController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AIController.js","sourceRoot":"","sources":["AIController.ts"],"names":[],"mappings":";;;;;;;;;AA0DA;;GAEG;AACH,MAAM,OAAO,YAAY;IAWrB,YAAY,aAA8B;QACtC,IAAI,aAAa,CAAC,IAAI,EAAE;YACpB,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC;YAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC;YAC5B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,CAAC,kBAAkB,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;YAC7D,IAAI,CAAC,6BAA6B;gBAC9B,OAAO,OAAO,CAAC,4BAA4B,KAAK,SAAS;oBACrD,CAAC,CAAC,OAAO,CAAC,4BAA4B;oBACtC,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;SAC3D;QAED,IAAI,aAAa,CAAC,cAAc,EAAE;YAC9B,IAAI,CAAC,eAAe,GAAG,aAAa,CAAC,cAAc,CAAC,SAAS,CAAC;YAC9D,MAAM,OAAO,GAAG,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC;YACrD,IAAI,CAAC,uCAAuC;gBACxC,OAAO,OAAO,CAAC,wBAAwB,KAAK,SAAS;oBACjD,CAAC,CAAC,OAAO,CAAC,wBAAwB;oBAClC,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;SACvD;IACL,CAAC;IAEK,IAAI,CAAC,OAAsB;;;YAC7B,IAAI;gBACA,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;oBACb,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EAAE,kCAAkC;qBACnD,CAAC;iBACL;gBACD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;oBACjB,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EACR,yEAAyE;qBAChF,CAAC;iBACL;gBAED,IACI,CAAC,IAAI,CAAC,yBAAyB,CAC3B,OAAO,CAAC,oBAAoB,EAC5B,IAAI,CAAC,6BAA6B,CACrC,EACH;oBACE,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE;wBAC/B,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,gBAAgB;4BAC3B,YAAY,EACR,6DAA6D;4BACjE,wBAAwB,EAAE;gCACtB,GAAI,IAAI;qCACH,6BAA6C;6BACrD;yBACJ,CAAC;qBACL;yBAAM;wBACH,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,2BAA2B;4BACtC,YAAY,EACR,iFAAiF;4BACrF,wBAAwB,EAAE;gCACtB,GAAI,IAAI;qCACH,6BAA6C;6BACrD;4BACD,uBAAuB,EAAE,OAAO,CAAC,oBAAoB;yBACxD,CAAC;qBACL;iBACJ;gBAED,IACI,CAAC,CAAC,OAAO,CAAC,KAAK;oBACf,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,EAC7C;oBACE,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EAAE,2CAA2C;qBAC5D,CAAC;iBACL;gBAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;oBACjC,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,KAAK,EAAE,MAAA,OAAO,CAAC,KAAK,mCAAI,IAAI,CAAC,YAAY,CAAC,YAAY;oBACtD,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;oBAC1C,eAAe,EAAE,OAAO,CAAC,eAAe;oBACxC,SAAS,EAAE,OAAO,CAAC,SAAS;oBAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;iBACzB,CAAC,CAAC;gBAEH,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,MAAM,CAAC,OAAO;iBAC1B,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,GAAG,CAAC,CAAC;gBAClE,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,0BAA0B;iBAC3C,CAAC;aACL;;KACJ;IAEK,cAAc,CAChB,OAAgC;;YAEhC,IAAI;gBACA,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;oBACvB,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EAAE,kCAAkC;qBACnD,CAAC;iBACL;gBAED,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;oBACjB,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EACR,yEAAyE;qBAChF,CAAC;iBACL;gBAED,IACI,CAAC,IAAI,CAAC,yBAAyB,CAC3B,OAAO,CAAC,oBAAoB,EAC5B,IAAI,CAAC,uCAAuC,CAC/C,EACH;oBACE,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE;wBAC/B,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,gBAAgB;4BAC3B,YAAY,EACR,6DAA6D;4BACjE,wBAAwB,EAAE;gCACtB,GAAI,IAAI;qCACH,uCAAuD;6BAC/D;yBACJ,CAAC;qBACL;yBAAM;wBACH,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,2BAA2B;4BACtC,YAAY,EACR,iFAAiF;4BACrF,wBAAwB,EAAE;gCACtB,GAAI,IAAI;qCACH,uCAAuD;6BAC/D;4BACD,uBAAuB,EAAE,OAAO,CAAC,oBAAoB;yBACxD,CAAC;qBACL;iBACJ;gBAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC;oBACrD,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,cAAc,EAAE,OAAO,CAAC,cAAc;oBACtC,YAAY,EAAE,OAAO,CAAC,YAAY;iBACrC,CAAC,CAAC;gBAEH,IAAI,MAAM,CAAC,OAAO,KAAK,IAAI,EAAE;oBACzB,OAAO;wBACH,OAAO,EAAE,IAAI;wBACb,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,YAAY,EAAE,MAAM,CAAC,YAAY;qBACpC,CAAC;iBACL;qBAAM;oBACH,OAAO,MAAM,CAAC;iBACjB;aACJ;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,CAAC,KAAK,CACT,wDAAwD,EACxD,GAAG,CACN,CAAC;gBACF,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,0BAA0B;iBAC3C,CAAC;aACL;QACL,CAAC;KAAA;IAEO,yBAAyB,CAC7B,IAAY,EACZ,YAAgC;QAEhC,OAAO,YAAY,KAAK,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;CACJ"}

package/AIGenerateSkyboxInterface.d.ts

@@ -0,0 +1,63 @@
+import { ServerError } from './Errors';
+/**
+ * Defines an interface that is able to send and receive AI chat messages.
+ */
+export interface AIGenerateSkyboxInterface {
+    /**
+     * Sends a generate skybox request to the AI API.
+     * @param request The request to send.
+     */
+    generateSkybox(request: AIGenerateSkyboxInterfaceRequest): Promise<AIGenerateSkyboxInterfaceResponse>;
+}
+export interface AIGenerateSkyboxInterfaceRequest {
+    /**
+     * The prompt to use.
+     */
+    prompt: string;
+    /**
+     * The negative prompt to use.
+     */
+    negativePrompt?: string | null;
+    /**
+     * Options specific to blockade labs.
+     */
+    blockadeLabs?: AIGenerateSkyboxInterfaceBlockadeLabsOptions;
+}
+/**
+ * Options specific to blockade labs.
+ */
+export interface AIGenerateSkyboxInterfaceBlockadeLabsOptions {
+    /**
+     * The pre-defined style ID for the skybox.
+     */
+    skyboxStyleId?: number;
+    /**
+     * The ID of a previously generated skybox.
+     */
+    remixImagineId?: number;
+    /**
+     * The random seed to use for generating the skybox.
+     */
+    seed?: number;
+}
+/**
+ * Defines an interface that represents an generate skybox response.
+ */
+export type AIGenerateSkyboxInterfaceResponse = AIGenerateSkyboxInterfaceResponseSuccess | AIGenerateSkyboxInterfaceResponseFailure;
+export interface AIGenerateSkyboxInterfaceResponseSuccess {
+    success: true;
+    /**
+     * The URL of the file that was generated.
+     */
+    fileUrl: string;
+    /**
+     * The URL of the thumbnail for the file.
+     */
+    thumbnailUrl?: string;
+}
+export interface AIGenerateSkyboxInterfaceResponseFailure {
+    success: false;
+    errorCode: ServerError;
+    errorMessage: string;
+}
+//# sourceMappingURL=AIGenerateSkyboxInterface.d.ts.map

package/AIGenerateSkyboxInterface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AIGenerateSkyboxInterface.js.map

package/AIGenerateSkyboxInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AIGenerateSkyboxInterface.js","sourceRoot":"","sources":["AIGenerateSkyboxInterface.ts"],"names":[],"mappings":""}

package/AuthController.d.ts

@@ -81,6 +81,7 @@ export declare class AuthController {
      * @param request The request.
      */
     getUserInfo(request: GetUserInfoRequest): Promise<GetUserInfoResult>;
+    private _getSubscriptionInfo;
     /**
      * Attempts to update a user's metadata.
      * @param request The request for the operation.
@@ -199,6 +200,14 @@ export interface ValidateSessionKeySuccess {
     userId: string;
     sessionId: string;
     allSessionsRevokedTimeMs?: number;
+    /**
+     * The subscription ID for the user.
+     */
+    subscriptionTier?: string;
+    /**
+     * The ID of the subscription that the user is subscribed to.
+     */
+    subscriptionId?: string;
 }
 export interface ValidateSessionKeyFailure {
     success: false;

package/AuthController.js

@@ -447,11 +447,14 @@ export class AuthController {
                         };
                     }
                 }
+                const { subscriptionId, subscriptionTier } = this._getSubscriptionInfo(userInfo);
                 return {
                     success: true,
                     userId: session.userId,
                     sessionId: session.sessionId,
                     allSessionsRevokedTimeMs: userInfo.allSessionRevokeTimeMs,
+                    subscriptionId: subscriptionId !== null && subscriptionId !== void 0 ? subscriptionId : undefined,
+                    subscriptionTier: subscriptionTier !== null && subscriptionTier !== void 0 ? subscriptionTier : undefined,
                 };
             }
             catch (err) {
@@ -729,7 +732,6 @@ export class AuthController {
      * @param request The request.
      */
     getUserInfo(request) {
-        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof request.userId !== 'string' || request.userId === '') {
                 return {
@@ -763,28 +765,7 @@ export class AuthController {
                 if (!result) {
                     throw new Error('Unable to find user even though a valid session key was presented!');
                 }
-                const hasActiveSubscription = this._forceAllowSubscriptionFeatures ||
-                    isActiveSubscription(result.subscriptionStatus);
-                let sub;
-                if (result.subscriptionId) {
-                    sub = (_a = this._subscriptionConfig) === null || _a === void 0 ? void 0 : _a.subscriptions.find((s) => s.id === result.subscriptionId);
-                }
-                if (!sub) {
-                    sub = (_b = this._subscriptionConfig) === null || _b === void 0 ? void 0 : _b.subscriptions.find((s) => s.defaultSubscription);
-                    if (sub) {
-                        console.log('[AuthController] [getUserInfo] Using default subscription for user.');
-                    }
-                }
-                if (!sub) {
-                    sub = (_c = this._subscriptionConfig) === null || _c === void 0 ? void 0 : _c.subscriptions[0];
-                    if (sub) {
-                        console.log('[AuthController] [getUserInfo] Using first subscription for user.');
-                    }
-                }
-                let tier = 'beta';
-                if (sub && sub.tier) {
-                    tier = sub.tier;
-                }
+                const { hasActiveSubscription, subscriptionTier: tier } = this._getSubscriptionInfo(result);
                 return {
                     success: true,
                     userId: result.id,
@@ -793,7 +774,7 @@ export class AuthController {
                     phoneNumber: result.phoneNumber,
                     avatarPortraitUrl: result.avatarPortraitUrl,
                     avatarUrl: result.avatarUrl,
-                    hasActiveSubscription,
+                    hasActiveSubscription: hasActiveSubscription,
                     subscriptionTier: hasActiveSubscription ? tier : null,
                     openAiKey: hasActiveSubscription ? result.openAiKey : null,
                 };
@@ -808,6 +789,39 @@ export class AuthController {
             }
         });
     }
+    _getSubscriptionInfo(user) {
+        var _a, _b, _c;
+        const hasActiveSubscription = this._forceAllowSubscriptionFeatures ||
+            isActiveSubscription(user.subscriptionStatus);
+        let tier = null;
+        let sub = null;
+        if (hasActiveSubscription) {
+            if (user.subscriptionId) {
+                sub = (_a = this._subscriptionConfig) === null || _a === void 0 ? void 0 : _a.subscriptions.find((s) => s.id === user.subscriptionId);
+            }
+            if (!sub) {
+                sub = (_b = this._subscriptionConfig) === null || _b === void 0 ? void 0 : _b.subscriptions.find((s) => s.defaultSubscription);
+                if (sub) {
+                    console.log('[AuthController] [getUserInfo] Using default subscription for user.');
+                }
+            }
+            if (!sub) {
+                sub = (_c = this._subscriptionConfig) === null || _c === void 0 ? void 0 : _c.subscriptions[0];
+                if (sub) {
+                    console.log('[AuthController] [getUserInfo] Using first subscription for user.');
+                }
+            }
+            tier = 'beta';
+            if (sub && sub.tier) {
+                tier = sub.tier;
+            }
+        }
+        return {
+            hasActiveSubscription,
+            subscriptionId: sub === null || sub === void 0 ? void 0 : sub.id,
+            subscriptionTier: tier,
+        };
+    }
     /**
      * Attempts to update a user's metadata.
      * @param request The request for the operation.