@casual-simulation/aux-records 3.2.3 → 3.2.4-alpha.5940763320

package/RecordsStore.d.ts

@@ -35,7 +35,97 @@ export interface RecordsStore {
      *
      * @param ownerId The ID of the user that owns the records.
      */
-    listRecordsByOwnerId?(ownerId: string): Promise<ListedRecord[]>;
+    listRecordsByOwnerId(ownerId: string): Promise<ListedRecord[]>;
+    /**
+     * Gets the list of records that the studio with the given ID owns.
+     *
+     * If null or undefined, then this store does not support this method.
+     *
+     * @param studioId The ID of the studio that owns the records.
+     */
+    listRecordsByStudioId(studioId: string): Promise<ListedRecord[]>;
+    /**
+     * Gets the list of records that the studio with the given ID owns and that the user with the given ID has access to.
+     * @param studioId The ID of the studio.
+     * @param userId The ID of the user.
+     */
+    listRecordsByStudioIdAndUserId(studioId: string, userId: string): Promise<ListedRecord[]>;
+    /**
+     * Adds the given studio to the store.
+     * @param studio The studio to add.
+     */
+    addStudio(studio: Studio): Promise<void>;
+    /**
+     * Creates a new studio and adds the given user as an admin.
+     * @param studio The studio to create.
+     * @param adminId The ID of the admin user.
+     */
+    createStudioForUser(studio: Studio, adminId: string): Promise<{
+        studio: Studio;
+        assignment: StudioAssignment;
+    }>;
+    /**
+     * Updates the given studio.
+     * @param studio The studio record that should be updated.
+     */
+    updateStudio(studio: Studio): Promise<void>;
+    /**
+     * Gets the studio with the given ID.
+     * @param id The ID of the studio.
+     */
+    getStudioById(id: string): Promise<Studio>;
+    /**
+     * Gets the studio that has the given stripe customer ID.
+     * @param customerId The stripe customer ID for the studio.
+     */
+    getStudioByStripeCustomerId(customerId: string): Promise<Studio>;
+    /**
+     * Gets the list of studios that the user with the given ID has access to.
+     * @param userId The ID of the user.
+     */
+    listStudiosForUser(userId: string): Promise<ListedStudio[]>;
+    /**
+     * Adds the given studio assignment to the store.
+     * @param assignment The assignment to add.
+     */
+    addStudioAssignment(assignment: StudioAssignment): Promise<void>;
+    /**
+     * Updates the given studio assignment.
+     * @param assignment The assignment that should be updated.
+     */
+    updateStudioAssignment(assignment: StudioAssignment): Promise<void>;
+    /**
+     * Removes the given user from the given studio.
+     * @param studioId The ID of the studio.
+     * @param userId The ID of the user.
+     */
+    removeStudioAssignment(studioId: string, userId: string): Promise<void>;
+    /**
+     * Gets the list of users that have been assigned to the given studio.
+     * @param studioId The ID of the studio.
+     * @param filters The additional filters that should be used.
+     */
+    listStudioAssignments(studioId: string, filters?: ListStudioAssignmentFilters): Promise<ListedStudioAssignment[]>;
+    /**
+     * Gets the list of studio assignments that the user with the given ID has access to.
+     * @param userId The ID of the user.
+     */
+    listUserAssignments(userId: string): Promise<ListedUserAssignment[]>;
+    /**
+     * Counts the number of records that match the given filter.
+     * @param filter The filter.
+     */
+    countRecords(filter: CountRecordsFilter): Promise<number>;
+}
+export interface CountRecordsFilter {
+    /**
+     * The ID of user that owns the record.
+     */
+    ownerId?: string;
+    /**
+     * The ID of the studio that owns the record.
+     */
+    studioId?: string;
 }
 /**
  * Defines an interface for record objects.
@@ -46,9 +136,15 @@ export interface Record {
      */
     name: string;
     /**
-     * The ID of the user that created the record.
+     * The ID of the user that owns the record.
+     * Null if the record is owned by a studio.
+     */
+    ownerId: string | null;
+    /**
+     * The ID of the studio that owns the record.
+     * Null if the record is owned by a user.
      */
-    ownerId: string;
+    studioId: string | null;
     /**
      * The scrypt hashes of the secrets that allow access to the record.
      */
@@ -67,9 +163,171 @@ export interface ListedRecord {
      */
     name: string;
     /**
-     * The ID of the user that created the record.
+     * The ID of the user that owns the record.
+     * Null if owned by a studio.
+     */
+    ownerId: string | null;
+    /**
+     * The ID of the studio that owns the record.
+     * Null if owned by a user.
+     */
+    studioId: string | null;
+}
+/**
+ * Defines an interface for studio objects.
+ */
+export interface Studio {
+    /**
+     * The ID of the studio.
+     */
+    id: string;
+    /**
+     * The name of the studio.
+     */
+    displayName: string;
+    /**
+     * The ID of the stripe customer for this studio.
+     */
+    stripeCustomerId?: string;
+    /**
+     * The current subscription status for this studio.
+     */
+    subscriptionStatus?: string;
+    /**
+     * The ID of the stripe subscription that this studio currently has.
+     */
+    subscriptionId?: string;
+    /**
+     * The ID of the subscription that this studio record references.
+     */
+    subscriptionInfoId?: string;
+    /**
+     * The unix time in miliseconds that the studio's current subscription period started at.
+     */
+    subscriptionPeriodStartMs?: number | null;
+    /**
+     * The unix time in miliseconds that the studio's current subscription period ends at.
+     */
+    subscriptionPeriodEndMs?: number | null;
+}
+export type StudioAssignmentRole = 'admin' | 'member';
+/**
+ * Defines an interface for studio assignment objects.
+ */
+export interface StudioAssignment {
+    /**
+     * The ID of the studio that this assignment applies to.
+     */
+    studioId: string;
+    /**
+     * The ID of the user that this assignment applies to.
+     */
+    userId: string;
+    /**
+     * Whether the user is the primary contact for this studio.
+     */
+    isPrimaryContact: boolean;
+    /**
+     * The role that this user has in the studio.
+     */
+    role: StudioAssignmentRole;
+}
+export interface ListedStudioAssignment {
+    /**
+     * The ID of the studio that this assignment applies to.
+     */
+    studioId: string;
+    /**
+     * The ID of the user that this assignment applies to.
+     */
+    userId: string;
+    /**
+     * Whether the user is the primary contact for this studio.
+     */
+    isPrimaryContact: boolean;
+    /**
+     * The role that this user has in the studio.
+     */
+    role: StudioAssignmentRole;
+    /**
+     * The user that this assignment applies to.
+     */
+    user: ListedStudioAssignmentUser;
+}
+export interface ListedUserAssignment {
+    /**
+     * The name of the studio that this assignment applies to.
+     */
+    displayName: string;
+    /**
+     * The ID of the studio that this assignment applies to.
+     */
+    studioId: string;
+    /**
+     * The ID of the user that this assignment applies to.
+     */
+    userId: string;
+    /**
+     * Whether the user is the primary contact for this studio.
+     */
+    isPrimaryContact: boolean;
+    /**
+     * The role that this user has in the studio.
+     */
+    role: StudioAssignmentRole;
+}
+/**
+ * The user information for a listed studio assignment.
+ */
+export interface ListedStudioAssignmentUser {
+    /**
+     * The ID of the user.
+     */
+    id: string;
+    /**
+     * The name of the user.
+     */
+    name: string;
+    /**
+     * The email address of the user.
+     */
+    email: string;
+    /**
+     * The phone number of the user.
+     */
+    phoneNumber: string;
+}
+export interface ListedStudio {
+    /**
+     * The ID of the studio.
+     */
+    studioId: string;
+    /**
+     * The name of the studio.
+     */
+    displayName: string;
+    /**
+     * The role that the user has in the studio.
+     */
+    role: StudioAssignmentRole;
+    /**
+     * Whether the user is the primary contact for this studio.
+     */
+    isPrimaryContact: boolean;
+}
+export interface ListStudioAssignmentFilters {
+    /**
+     * The ID of the user to filter by.
+     */
+    userId?: string;
+    /**
+     * The role to filter by.
+     */
+    role?: string;
+    /**
+     * Whether to filter by primary contact.
      */
-    ownerId: string;
+    isPrimaryContact?: boolean;
 }
 /**
  * Defines a type that represents the different kinds of policies that a record key can have.

package/StripeInterface.d.ts

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 /**
  * Defines an interface that represents the high-level Stripe-like functions that the SubscriptionController uses.
  */
@@ -43,6 +44,12 @@ export interface StripeInterface {
      * @param secret The secret that should be used to validate the payload against the signature.
      */
     constructWebhookEvent(payload: string, signature: string, secret: string): StripeEvent;
+    /**
+     * Gets the subscription with the given ID.
+     *
+     * @param id The ID of the subscription.
+     */
+    getSubscriptionById(id: string): Promise<Omit<StripeSubscription, 'items'>>;
 }
 export interface StripePrice {
     /**
@@ -366,4 +373,328 @@ export interface StripeProduct {
      */
     default_price: StripePrice;
 }
+export declare const STRIPE_INVOICE_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    currency: z.ZodString;
+    customer: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    subscription: z.ZodString;
+    hosted_invoice_url: z.ZodString;
+    invoice_pdf: z.ZodString;
+    total: z.ZodNumber;
+    subtotal: z.ZodNumber;
+    tax: z.ZodNullable<z.ZodNumber>;
+    status: z.ZodUnion<[z.ZodLiteral<"draft">, z.ZodLiteral<"open">, z.ZodLiteral<"void">, z.ZodLiteral<"paid">, z.ZodLiteral<"uncollectible">]>;
+    paid: z.ZodBoolean;
+    lines: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            price: z.ZodObject<{
+                id: z.ZodString;
+                product: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                id?: string;
+                product?: string;
+            }, {
+                id?: string;
+                product?: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            id?: string;
+            price?: {
+                id?: string;
+                product?: string;
+            };
+        }, {
+            id?: string;
+            price?: {
+                id?: string;
+                product?: string;
+            };
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        object?: "list";
+        data?: {
+            id?: string;
+            price?: {
+                id?: string;
+                product?: string;
+            };
+        }[];
+    }, {
+        object?: "list";
+        data?: {
+            id?: string;
+            price?: {
+                id?: string;
+                product?: string;
+            };
+        }[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    id?: string;
+    currency?: string;
+    customer?: string;
+    description?: string;
+    subscription?: string;
+    hosted_invoice_url?: string;
+    invoice_pdf?: string;
+    total?: number;
+    subtotal?: number;
+    tax?: number;
+    status?: "void" | "paid" | "open" | "draft" | "uncollectible";
+    paid?: boolean;
+    lines?: {
+        object?: "list";
+        data?: {
+            id?: string;
+            price?: {
+                id?: string;
+                product?: string;
+            };
+        }[];
+    };
+}, {
+    id?: string;
+    currency?: string;
+    customer?: string;
+    description?: string;
+    subscription?: string;
+    hosted_invoice_url?: string;
+    invoice_pdf?: string;
+    total?: number;
+    subtotal?: number;
+    tax?: number;
+    status?: "void" | "paid" | "open" | "draft" | "uncollectible";
+    paid?: boolean;
+    lines?: {
+        object?: "list";
+        data?: {
+            id?: string;
+            price?: {
+                id?: string;
+                product?: string;
+            };
+        }[];
+    };
+}>;
+export declare const STRIPE_EVENT_INVOICE_PAID_SCHEMA: z.ZodObject<{
+    type: z.ZodLiteral<"invoice.paid">;
+    data: z.ZodObject<{
+        object: z.ZodObject<{
+            id: z.ZodString;
+            currency: z.ZodString;
+            customer: z.ZodString;
+            description: z.ZodNullable<z.ZodString>;
+            subscription: z.ZodString;
+            hosted_invoice_url: z.ZodString;
+            invoice_pdf: z.ZodString;
+            total: z.ZodNumber;
+            subtotal: z.ZodNumber;
+            tax: z.ZodNullable<z.ZodNumber>;
+            status: z.ZodUnion<[z.ZodLiteral<"draft">, z.ZodLiteral<"open">, z.ZodLiteral<"void">, z.ZodLiteral<"paid">, z.ZodLiteral<"uncollectible">]>;
+            paid: z.ZodBoolean;
+            lines: z.ZodObject<{
+                object: z.ZodLiteral<"list">;
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    price: z.ZodObject<{
+                        id: z.ZodString;
+                        product: z.ZodString;
+                    }, "strip", z.ZodTypeAny, {
+                        id?: string;
+                        product?: string;
+                    }, {
+                        id?: string;
+                        product?: string;
+                    }>;
+                }, "strip", z.ZodTypeAny, {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }, {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                object?: "list";
+                data?: {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }[];
+            }, {
+                object?: "list";
+                data?: {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }[];
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            id?: string;
+            currency?: string;
+            customer?: string;
+            description?: string;
+            subscription?: string;
+            hosted_invoice_url?: string;
+            invoice_pdf?: string;
+            total?: number;
+            subtotal?: number;
+            tax?: number;
+            status?: "void" | "paid" | "open" | "draft" | "uncollectible";
+            paid?: boolean;
+            lines?: {
+                object?: "list";
+                data?: {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }[];
+            };
+        }, {
+            id?: string;
+            currency?: string;
+            customer?: string;
+            description?: string;
+            subscription?: string;
+            hosted_invoice_url?: string;
+            invoice_pdf?: string;
+            total?: number;
+            subtotal?: number;
+            tax?: number;
+            status?: "void" | "paid" | "open" | "draft" | "uncollectible";
+            paid?: boolean;
+            lines?: {
+                object?: "list";
+                data?: {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }[];
+            };
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        object?: {
+            id?: string;
+            currency?: string;
+            customer?: string;
+            description?: string;
+            subscription?: string;
+            hosted_invoice_url?: string;
+            invoice_pdf?: string;
+            total?: number;
+            subtotal?: number;
+            tax?: number;
+            status?: "void" | "paid" | "open" | "draft" | "uncollectible";
+            paid?: boolean;
+            lines?: {
+                object?: "list";
+                data?: {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }[];
+            };
+        };
+    }, {
+        object?: {
+            id?: string;
+            currency?: string;
+            customer?: string;
+            description?: string;
+            subscription?: string;
+            hosted_invoice_url?: string;
+            invoice_pdf?: string;
+            total?: number;
+            subtotal?: number;
+            tax?: number;
+            status?: "void" | "paid" | "open" | "draft" | "uncollectible";
+            paid?: boolean;
+            lines?: {
+                object?: "list";
+                data?: {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }[];
+            };
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type?: "invoice.paid";
+    data?: {
+        object?: {
+            id?: string;
+            currency?: string;
+            customer?: string;
+            description?: string;
+            subscription?: string;
+            hosted_invoice_url?: string;
+            invoice_pdf?: string;
+            total?: number;
+            subtotal?: number;
+            tax?: number;
+            status?: "void" | "paid" | "open" | "draft" | "uncollectible";
+            paid?: boolean;
+            lines?: {
+                object?: "list";
+                data?: {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }[];
+            };
+        };
+    };
+}, {
+    type?: "invoice.paid";
+    data?: {
+        object?: {
+            id?: string;
+            currency?: string;
+            customer?: string;
+            description?: string;
+            subscription?: string;
+            hosted_invoice_url?: string;
+            invoice_pdf?: string;
+            total?: number;
+            subtotal?: number;
+            tax?: number;
+            status?: "void" | "paid" | "open" | "draft" | "uncollectible";
+            paid?: boolean;
+            lines?: {
+                object?: "list";
+                data?: {
+                    id?: string;
+                    price?: {
+                        id?: string;
+                        product?: string;
+                    };
+                }[];
+            };
+        };
+    };
+}>;
+export type StripeInvoice = z.infer<typeof STRIPE_INVOICE_SCHEMA>;
 //# sourceMappingURL=StripeInterface.d.ts.map

package/StripeInterface.js

@@ -1,2 +1,38 @@
-export {};
+import { z } from 'zod';
+export const STRIPE_INVOICE_SCHEMA = z.object({
+    id: z.string(),
+    currency: z.string(),
+    customer: z.string(),
+    description: z.string().nullable(),
+    subscription: z.string(),
+    hosted_invoice_url: z.string(),
+    invoice_pdf: z.string(),
+    total: z.number(),
+    subtotal: z.number(),
+    tax: z.number().nullable(),
+    status: z.union([
+        z.literal('draft'),
+        z.literal('open'),
+        z.literal('void'),
+        z.literal('paid'),
+        z.literal('uncollectible'),
+    ]),
+    paid: z.boolean(),
+    lines: z.object({
+        object: z.literal('list'),
+        data: z.array(z.object({
+            id: z.string(),
+            price: z.object({
+                id: z.string(),
+                product: z.string(),
+            }),
+        })),
+    }),
+});
+export const STRIPE_EVENT_INVOICE_PAID_SCHEMA = z.object({
+    type: z.literal('invoice.paid'),
+    data: z.object({
+        object: STRIPE_INVOICE_SCHEMA,
+    }),
+});
 //# sourceMappingURL=StripeInterface.js.map

package/StripeInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"StripeInterface.js","sourceRoot":"","sources":["StripeInterface.ts"],"names":[],"mappings":""}
+{"version":3,"file":"StripeInterface.js","sourceRoot":"","sources":["StripeInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAkdxB,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC;QACZ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAClB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACjB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACjB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACjB,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;KAC7B,CAAC;IACF,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IAEjB,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACzB,IAAI,EAAE,CAAC,CAAC,KAAK,CACT,CAAC,CAAC,MAAM,CAAC;YACL,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;YACd,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;gBACZ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;gBACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;aACtB,CAAC;SACL,CAAC,CACL;KACJ,CAAC;CACL,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACX,MAAM,EAAE,qBAAqB;KAChC,CAAC;CACL,CAAC,CAAC"}