@casual-simulation/aux-records 3.7.0 → 3.7.1-alpha.17585632798

package/SubscriptionConfiguration.d.ts

@@ -353,6 +353,19 @@ export declare const subscriptionFeaturesSchema: z.ZodObject<{
         allowed?: boolean;
         maxItems?: number;
     }>>>;
+    databases: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        allowed: z.ZodBoolean;
+        maxItems: z.ZodOptional<z.ZodNumber>;
+        maxBytesPerDatabase: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        allowed?: boolean;
+        maxItems?: number;
+        maxBytesPerDatabase?: number;
+    }, {
+        allowed?: boolean;
+        maxItems?: number;
+        maxBytesPerDatabase?: number;
+    }>>>;
 }, "strip", z.ZodTypeAny, {
     records?: {
         allowed?: boolean;
@@ -452,6 +465,11 @@ export declare const subscriptionFeaturesSchema: z.ZodObject<{
         allowed?: boolean;
         maxItems?: number;
     };
+    databases?: {
+        allowed?: boolean;
+        maxItems?: number;
+        maxBytesPerDatabase?: number;
+    };
 }, {
     records?: {
         allowed?: boolean;
@@ -551,6 +569,11 @@ export declare const subscriptionFeaturesSchema: z.ZodObject<{
         allowed?: boolean;
         maxItems?: number;
     };
+    databases?: {
+        allowed?: boolean;
+        maxItems?: number;
+        maxBytesPerDatabase?: number;
+    };
 }>;
 export declare const subscriptionConfigSchema: z.ZodObject<{
     webhookSecret: z.ZodString;
@@ -920,6 +943,19 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             }>>>;
+            databases: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                allowed: z.ZodBoolean;
+                maxItems: z.ZodOptional<z.ZodNumber>;
+                maxBytesPerDatabase: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }>>>;
         }, "strip", z.ZodTypeAny, {
             records?: {
                 allowed?: boolean;
@@ -1019,6 +1055,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }, {
             records?: {
                 allowed?: boolean;
@@ -1118,6 +1159,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }>>;
     }, "strip", z.ZodTypeAny, {
         features?: {
@@ -1219,6 +1265,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }, {
         features?: {
@@ -1320,6 +1371,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }>, z.objectOutputType<{}, z.ZodObject<{
         features: z.ZodOptional<z.ZodObject<{
@@ -1645,6 +1701,19 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             }>>>;
+            databases: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                allowed: z.ZodBoolean;
+                maxItems: z.ZodOptional<z.ZodNumber>;
+                maxBytesPerDatabase: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }>>>;
         }, "strip", z.ZodTypeAny, {
             records?: {
                 allowed?: boolean;
@@ -1744,6 +1813,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }, {
             records?: {
                 allowed?: boolean;
@@ -1843,6 +1917,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }>>;
     }, "strip", z.ZodTypeAny, {
         features?: {
@@ -1944,6 +2023,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }, {
         features?: {
@@ -2045,6 +2129,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }>, "strip">, z.objectInputType<{}, z.ZodObject<{
         features: z.ZodOptional<z.ZodObject<{
@@ -2370,6 +2459,19 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             }>>>;
+            databases: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                allowed: z.ZodBoolean;
+                maxItems: z.ZodOptional<z.ZodNumber>;
+                maxBytesPerDatabase: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }>>>;
         }, "strip", z.ZodTypeAny, {
             records?: {
                 allowed?: boolean;
@@ -2469,6 +2571,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }, {
             records?: {
                 allowed?: boolean;
@@ -2568,6 +2675,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }>>;
     }, "strip", z.ZodTypeAny, {
         features?: {
@@ -2669,6 +2781,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }, {
         features?: {
@@ -2770,6 +2887,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }>, "strip">>>;
     defaultFeatures: z.ZodOptional<z.ZodObject<{
@@ -3096,6 +3218,19 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             }>>>;
+            databases: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                allowed: z.ZodBoolean;
+                maxItems: z.ZodOptional<z.ZodNumber>;
+                maxBytesPerDatabase: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }>>>;
         }, "strip", z.ZodTypeAny, {
             records?: {
                 allowed?: boolean;
@@ -3195,6 +3330,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }, {
             records?: {
                 allowed?: boolean;
@@ -3294,6 +3434,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }>>;
         studio: z.ZodOptional<z.ZodObject<{
             records: z.ZodOptional<z.ZodObject<{
@@ -3618,6 +3763,19 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             }>>>;
+            databases: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                allowed: z.ZodBoolean;
+                maxItems: z.ZodOptional<z.ZodNumber>;
+                maxBytesPerDatabase: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }>>>;
         }, "strip", z.ZodTypeAny, {
             records?: {
                 allowed?: boolean;
@@ -3717,6 +3875,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }, {
             records?: {
                 allowed?: boolean;
@@ -3816,6 +3979,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }>>;
         defaultPeriodLength: z.ZodDefault<z.ZodOptional<z.ZodObject<{
             days: z.ZodOptional<z.ZodNumber>;
@@ -3940,6 +4108,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
         studio?: {
             records?: {
@@ -4040,6 +4213,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
         defaultPeriodLength?: {
             days?: number;
@@ -4150,6 +4328,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
         studio?: {
             records?: {
@@ -4250,6 +4433,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
         defaultPeriodLength?: {
             days?: number;
@@ -4605,6 +4793,19 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             }>>>;
+            databases: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                allowed: z.ZodBoolean;
+                maxItems: z.ZodOptional<z.ZodNumber>;
+                maxBytesPerDatabase: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }>>>;
         }, "strip", z.ZodTypeAny, {
             records?: {
                 allowed?: boolean;
@@ -4704,6 +4905,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }, {
             records?: {
                 allowed?: boolean;
@@ -4803,6 +5009,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }>>;
     }, "strip", z.ZodTypeAny, {
         features?: {
@@ -4904,6 +5115,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }, {
         features?: {
@@ -5005,6 +5221,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }>, "strip">;
     defaultFeatures?: {
@@ -5107,6 +5328,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
         studio?: {
             records?: {
@@ -5207,6 +5433,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
         defaultPeriodLength?: {
             days?: number;
@@ -5562,6 +5793,19 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             }>>>;
+            databases: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                allowed: z.ZodBoolean;
+                maxItems: z.ZodOptional<z.ZodNumber>;
+                maxBytesPerDatabase: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }, {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            }>>>;
         }, "strip", z.ZodTypeAny, {
             records?: {
                 allowed?: boolean;
@@ -5661,6 +5905,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }, {
             records?: {
                 allowed?: boolean;
@@ -5760,6 +6009,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         }>>;
     }, "strip", z.ZodTypeAny, {
         features?: {
@@ -5861,6 +6115,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }, {
         features?: {
@@ -5962,6 +6221,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
     }>, "strip">;
     defaultFeatures?: {
@@ -6064,6 +6328,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
         studio?: {
             records?: {
@@ -6164,6 +6433,11 @@ export declare const subscriptionConfigSchema: z.ZodObject<{
                 allowed?: boolean;
                 maxItems?: number;
             };
+            databases?: {
+                allowed?: boolean;
+                maxItems?: number;
+                maxBytesPerDatabase?: number;
+            };
         };
         defaultPeriodLength?: {
             days?: number;
@@ -6372,6 +6646,10 @@ export interface FeaturesConfiguration {
      * The configuration for search features.
      */
     search?: SearchFeaturesConfiguration;
+    /**
+     * The configuration for database features.
+     */
+    databases?: DatabasesFeaturesConfiguration;
 }
 export interface RecordFeaturesConfiguration {
     /**
@@ -6568,8 +6846,17 @@ export type WebhooksFeaturesConfiguration = z.infer<typeof subscriptionFeaturesS
 export type NotificationFeaturesConfiguration = z.infer<typeof subscriptionFeaturesSchema>['notifications'];
 export type PackageFeaturesConfiguration = z.infer<typeof subscriptionFeaturesSchema>['packages'];
 export type SearchFeaturesConfiguration = z.infer<typeof subscriptionFeaturesSchema>['search'];
+export type DatabasesFeaturesConfiguration = z.infer<typeof subscriptionFeaturesSchema>['databases'];
 export declare function allowAllFeatures(): FeaturesConfiguration;
 export declare function denyAllFeatures(): FeaturesConfiguration;
+/**
+ * Gets the database features that are available for the given subscription.
+ * @param config The configuration. If null, then all default features are allowed.
+ * @param subscriptionStatus The status of the subscription.
+ * @param subscriptionId The ID of the subscription.
+ * @param type The type of the user.
+ */
+export declare function getDatabaseFeatures(config: SubscriptionConfiguration | null, subscriptionStatus: string, subscriptionId: string, type: 'user' | 'studio', periodStartMs?: number | null, periodEndMs?: number | null, nowMs?: number): DatabasesFeaturesConfiguration;
 /**
  * Gets the search features that are available for the given subscription.
  * @param config The configuration. If null, then all default features are allowed.

package/SubscriptionConfiguration.js

@@ -427,6 +427,29 @@ export const subscriptionFeaturesSchema = z.object({
         .default({
         allowed: true,
     }),
+    databases: z
+        .object({
+        allowed: z
+            .boolean()
+            .describe('Whether database records are allowed for the subscription.'),
+        maxItems: z
+            .number()
+            .describe('The maximum number of database records that can be created for the subscription. If not specified, then there is no limit.')
+            .int()
+            .positive()
+            .optional(),
+        maxBytesPerDatabase: z
+            .number()
+            .describe('The maximum size of the database in bytes. If not specified, then there is no limit.')
+            .int()
+            .positive()
+            .optional(),
+    })
+        .describe('The configuration for database records features. Defaults to allowed.')
+        .optional()
+        .default({
+        allowed: true,
+    }),
 });
 export const subscriptionConfigSchema = z.object({
     webhookSecret: z
@@ -619,6 +642,9 @@ export function allowAllFeatures() {
         search: {
             allowed: true,
         },
+        databases: {
+            allowed: true,
+        },
     };
 }
 export function denyAllFeatures() {
@@ -669,8 +695,23 @@ export function denyAllFeatures() {
         search: {
             allowed: false,
         },
+        databases: {
+            allowed: false,
+        },
     };
 }
+/**
+ * Gets the database features that are available for the given subscription.
+ * @param config The configuration. If null, then all default features are allowed.
+ * @param subscriptionStatus The status of the subscription.
+ * @param subscriptionId The ID of the subscription.
+ * @param type The type of the user.
+ */
+export function getDatabaseFeatures(config, subscriptionStatus, subscriptionId, type, periodStartMs, periodEndMs, nowMs = Date.now()) {
+    var _a;
+    const features = getSubscriptionFeatures(config, subscriptionStatus, subscriptionId, type, periodStartMs, periodEndMs, nowMs);
+    return (_a = features.databases) !== null && _a !== void 0 ? _a : { allowed: true };
+}
 /**
  * Gets the search features that are available for the given subscription.
  * @param config The configuration. If null, then all default features are allowed.