@casual-simulation/aux-records 3.8.1 → 3.10.2

package/RecordsStore.d.ts

@@ -1,6 +1,8 @@
 import { z } from 'zod';
 import type { ComIdConfig, ComIdPlayerConfig } from './ComIdConfig';
 import type { PublicRecordKeyPolicy } from '@casual-simulation/aux-common';
+import type { StripeAccountStatus, StripeRequirementsStatus } from './StripeInterface';
+import type { WebManifest } from '@casual-simulation/aux-common/common/WebManifest';
 /**
  * Defines an interface for objects that can store records.
  */
@@ -165,6 +167,43 @@ export interface RecordsStore {
      * @param config The config that should be updated for the studio.
      */
     updateStudioHumeConfig(studioId: string, config: HumeConfig): Promise<void>;
+    /**
+     * Gets the studio with the given stripe account ID. Returns null if no studio has that stripe account ID.
+     * @param accountId The ID of the stripe account.
+     */
+    getStudioByStripeAccountId(accountId: string): Promise<Studio | null>;
+    /**
+     * Saves the given custom domain to the store.
+     * @param domain The custom domain to save.
+     */
+    saveCustomDomain(domain: CustomDomain): Promise<void>;
+    /**
+     * Removes the custom domain with the given ID from the store.
+     * @param domainId The ID of the custom domain to remove.
+     */
+    deleteCustomDomain(domainId: string): Promise<void>;
+    /**
+     * Gets the custom domain with the given ID.
+     * @param domainId The ID of the custom domain.
+     */
+    getCustomDomainById(domainId: string): Promise<CustomDomainWithStudio | null>;
+    /**
+     * Gets the list of custom domains for the given studio ID.
+     * @param studioId The ID of the studio.
+     */
+    listCustomDomainsByStudioId(studioId: string): Promise<CustomDomain[]>;
+    /**
+     * Gets the verified custom domain with the given domain name.
+     * Returns null if no verified custom domain with the given name exists.
+     *
+     * @param domainName The domain name.
+     */
+    getVerifiedCustomDomainByName(domainName: string): Promise<CustomDomainWithStudio | null>;
+    /**
+     * Marks the custom domain with the given ID as verified.
+     * @param domainId The ID of the custom domain to mark as verified.
+     */
+    markCustomDomainAsVerified(domainId: string): Promise<void>;
 }
 export interface CountRecordsFilter {
     /**
@@ -242,6 +281,28 @@ export interface Studio {
      * The ID of the stripe customer for this studio.
      */
     stripeCustomerId?: string;
+    /**
+     * The ID of the stripe account for this studio.
+     */
+    stripeAccountId?: string | null;
+    /**
+     * The status of the stripe account requirements for this studio.
+     *
+     * If null, then the studio does not have a stripe account.
+     * If 'incomplete', then the studio has a stripe account but it is not fully set up.
+     * If 'complete', then the studio has a stripe account that is fully set up.
+     */
+    stripeAccountRequirementsStatus?: StripeRequirementsStatus;
+    /**
+     * The status of the stripe account that is associated with this studio.
+     *
+     * If null, then the studio does not have a stripe account.
+     * If 'active', then the stripe account has been approved and is active.
+     * If 'pending', then the stripe account is waiting approval.
+     * If 'rejected', then the stripe account was rejected.
+     * If 'disabled', then the stripe account was disabled but not because it was rejected.
+     */
+    stripeAccountStatus?: StripeAccountStatus;
     /**
      * The current subscription status for this studio.
      */
@@ -275,6 +336,10 @@ export interface Studio {
      * The player web config for the studio.
      */
     playerConfig?: ComIdPlayerConfig;
+    /**
+     * The PWA web manifest that should be served for the player.
+     */
+    playerWebManifest?: WebManifest;
     /**
      * The config for comId features.
      */
@@ -284,23 +349,11 @@ export type LoomConfig = z.infer<typeof LOOM_CONFIG>;
 export declare const LOOM_CONFIG: z.ZodObject<{
     appId: z.ZodString;
     privateKey: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    appId?: string;
-    privateKey?: string;
-}, {
-    appId?: string;
-    privateKey?: string;
-}>;
+}, z.core.$strip>;
 export declare const HUME_CONFIG: z.ZodObject<{
     apiKey: z.ZodString;
     secretKey: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    apiKey?: string;
-    secretKey?: string;
-}, {
-    apiKey?: string;
-    secretKey?: string;
-}>;
+}, z.core.$strip>;
 export type HumeConfig = z.infer<typeof HUME_CONFIG>;
 /**
  * Defines the list of possible studio roles that a user can be assigned.
@@ -509,4 +562,36 @@ export interface StudioComIdRequest {
      */
     updatedAtMs: number;
 }
+/**
+ * Represents a custom domain that is associated with a studio.
+ *
+ * These domains may or may not be verified.
+ */
+export interface CustomDomain {
+    /**
+     * The ID of the custom domain.
+     */
+    id: string;
+    /**
+     * The domain name.
+     */
+    domainName: string;
+    /**
+     * The ID of the studio that the custom domain is associated with.
+     */
+    studioId: string;
+    /**
+     * The HMAC-SHA-256 verification key.
+     */
+    verificationKey: string;
+    /**
+     * Whether the custom domain has been verified.
+     * Null if not verified.
+     */
+    verified: true | null;
+}
+export type ListedCustomDomain = Pick<CustomDomain, 'id' | 'domainName' | 'verified'>;
+export interface CustomDomainWithStudio extends CustomDomain {
+    studio: Studio;
+}
 //# sourceMappingURL=RecordsStore.d.ts.map

package/RecordsStore.js

@@ -16,20 +16,18 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 import { z } from 'zod';
-export const LOOM_CONFIG = z
-    .object({
-    appId: z.string().describe('The ID of the loom app.').max(100),
+export const LOOM_CONFIG = z.object({
+    appId: z.string().max(100).describe('The ID of the loom app.'),
     privateKey: z
         .string()
-        .describe('The private key for the loom app.')
-        .max(100),
-})
-    .describe('The configuration that can be used by studios to setup loom.');
+        .max(100)
+        .describe('The private key for the loom app.'),
+});
 export const HUME_CONFIG = z.object({
-    apiKey: z.string().describe('The API key for the Hume service.').max(100),
+    apiKey: z.string().max(100).describe('The API key for the Hume service.'),
     secretKey: z
         .string()
-        .describe('The secret key for the Hume service.')
-        .max(100),
+        .max(100)
+        .describe('The secret key for the Hume service.'),
 });
 //# sourceMappingURL=RecordsStore.js.map

package/RecordsStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"RecordsStore.js","sourceRoot":"","sources":["RecordsStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AA+VxB,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACvB,MAAM,CAAC;IACJ,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC9D,UAAU,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,CAAC,mCAAmC,CAAC;SAC7C,GAAG,CAAC,GAAG,CAAC;CAChB,CAAC;KACD,QAAQ,CAAC,8DAA8D,CAAC,CAAC;AAE9E,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACzE,SAAS,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,CAAC,sCAAsC,CAAC;SAChD,GAAG,CAAC,GAAG,CAAC;CAChB,CAAC,CAAC"}
+{"version":3,"file":"RecordsStore.js","sourceRoot":"","sources":["RecordsStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAkbxB,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IAC9D,UAAU,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,CAAC,GAAG,CAAC;SACR,QAAQ,CAAC,mCAAmC,CAAC;CACrD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC;IACzE,SAAS,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,CAAC,GAAG,CAAC;SACR,QAAQ,CAAC,sCAAsC,CAAC;CACxD,CAAC,CAAC"}