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

package/database/DatabaseRecordsController.d.ts

@@ -0,0 +1,92 @@
+import type { ActionKinds, Result, SimpleError } from '@casual-simulation/aux-common';
+import type { AuthorizationContext, AuthorizeUserAndInstancesSuccess, AuthorizeUserAndInstancesForResourcesSuccess } from '../PolicyController';
+import type { CrudRecordsConfiguration, CheckSubscriptionMetricsFailure, CheckSubscriptionMetricsSuccess } from '../crud';
+import { CrudRecordsController } from '../crud';
+import type { DatabasesFeaturesConfiguration, SubscriptionConfiguration } from '../SubscriptionConfiguration';
+import type { DatabaseRecord, DatabaseRecordsStore, DatabaseSubscriptionMetrics } from './DatabaseRecordsStore';
+import type { DatabaseInterface, DatabaseStatement, QueryResult, SQliteDatabase, TursoDatabase } from './DatabaseInterface';
+export type DatabaseType = SQliteDatabase | TursoDatabase;
+/**
+ * Defines the configuration for a webhook records controller.
+ */
+export interface DatabaseRecordsConfiguration extends Omit<CrudRecordsConfiguration<DatabaseRecord, DatabaseRecordsStore>, 'resourceKind' | 'allowRecordKeys' | 'name'> {
+    /**
+     * The name of the provider that the interface uses.
+     */
+    databaseInterfaceProviderName: 'sqlite' | 'turso';
+    /**
+     * The interface to the search engine that should be used.
+     */
+    databaseInterface: DatabaseInterface<DatabaseType>;
+}
+/**
+ * Defines a controller that can be used to interact with DatabaseRecords.
+ */
+export declare class DatabaseRecordsController extends CrudRecordsController<DatabaseRecordInput, DatabaseRecord, DatabaseRecordsStore, DatabaseRecordOutput> {
+    private _databaseInterface;
+    private _providerName;
+    constructor(config: DatabaseRecordsConfiguration);
+    query(request: DatabaseQuery): Promise<Result<QueryResult[], SimpleError>>;
+    protected _eraseItemCore(recordName: string, address: string, item: DatabaseRecord, authorization: AuthorizeUserAndInstancesSuccess | AuthorizeUserAndInstancesForResourcesSuccess): Promise<Result<void, SimpleError>>;
+    protected _convertItemToResult(item: DatabaseRecord, context: AuthorizationContext, action: ActionKinds): Promise<DatabaseRecordOutput>;
+    protected _convertItemsToResults(items: DatabaseRecord[], context: AuthorizationContext, action: ActionKinds): Promise<DatabaseRecordOutput[]>;
+    protected _transformInputItem(item: DatabaseRecordInput, existingItem: DatabaseRecord, action: ActionKinds, context: AuthorizationContext, authorization: AuthorizeUserAndInstancesSuccess | AuthorizeUserAndInstancesForResourcesSuccess, metrics: DatabaseRecordsSubscriptionMetricsSuccess): Promise<Result<DatabaseRecord, SimpleError>>;
+    protected _checkSubscriptionMetrics(action: ActionKinds, context: AuthorizationContext, authorization: AuthorizeUserAndInstancesSuccess | AuthorizeUserAndInstancesForResourcesSuccess, item?: DatabaseRecordInput): Promise<DatabaseRecordsSubscriptionMetricsResult>;
+}
+export type DatabaseRecordsSubscriptionMetricsResult = DatabaseRecordsSubscriptionMetricsSuccess | CheckSubscriptionMetricsFailure;
+export interface DatabaseRecordsSubscriptionMetricsSuccess extends CheckSubscriptionMetricsSuccess {
+    config: SubscriptionConfiguration;
+    metrics: DatabaseSubscriptionMetrics;
+    features: DatabasesFeaturesConfiguration;
+}
+export interface DatabaseRecordInput extends Omit<DatabaseRecord, 'databaseInfo' | 'databaseProvider' | 'databaseName'> {
+}
+/**
+ * Defines a record that represents a database that can be queried using SQL.
+ *
+ * @dochash types/records/database
+ * @docname DatabaseRecord
+ */
+export interface DatabaseRecordOutput extends Omit<DatabaseRecord, 'databaseInfo' | 'databaseProvider' | 'databaseName'> {
+}
+/**
+ * Defines a request to query a database.
+ *
+ * @dochash types/records/database
+ * @docname DatabaseQuery
+ */
+export interface DatabaseQuery {
+    /**
+     * The name of the record that the search should be performed on.
+     */
+    recordName: string;
+    /**
+     * The address of the search record that the search should be performed on.
+     */
+    address: string;
+    /**
+     * The SQL statements to execute.
+     */
+    statements: DatabaseStatement[];
+    /**
+     * Whether the query should be executed in read-only mode.
+     *
+     * This is a safety switch that helps prevent accidental modifications to the database.
+     */
+    readonly: boolean;
+    /**
+     * Whether to automatically wrap the statements in a transaction if there are multiple statements.
+     *
+     * Defaults to true.
+     */
+    automaticTransaction?: boolean;
+    /**
+     * The ID of the user that is currently logged in.
+     */
+    userId: string | null;
+    /**
+     * The instance(s) that are making the request.
+     */
+    instances: string[];
+}
+//# sourceMappingURL=DatabaseRecordsController.d.ts.map

package/database/DatabaseRecordsController.js

@@ -0,0 +1,167 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { failure, isFailure, success } from '@casual-simulation/aux-common';
+import { CrudRecordsController } from '../crud';
+import { getDatabaseFeatures } from '../SubscriptionConfiguration';
+import { v4 as uuid } from 'uuid';
+import { traced } from '../tracing/TracingDecorators';
+const TRACE_NAME = 'DatabaseRecordsController';
+/**
+ * Defines a controller that can be used to interact with DatabaseRecords.
+ */
+export class DatabaseRecordsController extends CrudRecordsController {
+    constructor(config) {
+        super({
+            ...config,
+            name: 'DatabaseRecordsController',
+            resourceKind: 'database',
+        });
+        this._providerName = config.databaseInterfaceProviderName;
+        this._databaseInterface = config.databaseInterface;
+    }
+    async query(request) {
+        var _a;
+        const baseRequest = {
+            recordKeyOrRecordName: request.recordName,
+            userId: request.userId,
+            instances: request.instances,
+        };
+        const context = await this.policies.constructAuthorizationContext(baseRequest);
+        if (context.success === false) {
+            return failure(context);
+        }
+        const item = await this.store.getItemByAddress(context.context.recordName, request.address);
+        if (!item) {
+            return failure({
+                success: false,
+                errorCode: 'data_not_found',
+                errorMessage: 'The item was not found.',
+            });
+        }
+        const markers = item.markers;
+        const resources = [
+            {
+                resourceKind: this.resourceKind,
+                resourceId: request.address,
+                markers: markers,
+                action: 'read',
+            },
+        ];
+        if (!request.readonly) {
+            resources.push({
+                resourceKind: this.resourceKind,
+                resourceId: request.address,
+                markers: markers,
+                action: 'update',
+            });
+        }
+        const authorization = await this.policies.authorizeUserAndInstancesForResources(context.context, {
+            userId: request.userId,
+            instances: request.instances,
+            resources: resources,
+        });
+        if (authorization.success === false) {
+            return failure(authorization);
+        }
+        const result = await this._databaseInterface.query(item.databaseInfo, request.statements, request.readonly, (_a = request.automaticTransaction) !== null && _a !== void 0 ? _a : true);
+        return result;
+    }
+    async _eraseItemCore(recordName, address, item, authorization) {
+        const result = await super._eraseItemCore(recordName, address, item, authorization);
+        if (isFailure(result)) {
+            return result;
+        }
+        await this._databaseInterface.deleteDatabase(item.databaseName);
+        return success();
+    }
+    async _convertItemToResult(item, context, action) {
+        return {
+            address: item.address,
+            markers: item.markers,
+        };
+    }
+    async _convertItemsToResults(items, context, action) {
+        return items.map((i) => ({
+            address: i.address,
+            markers: i.markers,
+        }));
+    }
+    async _transformInputItem(item, existingItem, action, context, authorization, metrics) {
+        if (action !== 'create' && action !== 'update') {
+            return failure({
+                errorCode: 'action_not_supported',
+                errorMessage: `The action '${action}' is not supported for database records.`,
+            });
+        }
+        if (action === 'create') {
+            const databaseName = uuid();
+            const database = await this._databaseInterface.createDatabase(databaseName, {
+                maxSizeBytes: metrics.features.maxBytesPerDatabase,
+            });
+            if (isFailure(database)) {
+                return database;
+            }
+            return success({
+                address: item.address,
+                markers: item.markers,
+                databaseProvider: this._providerName,
+                databaseInfo: database.value,
+                databaseName: databaseName,
+            });
+        }
+        else if (action === 'update') {
+            // For updates, we need to update the existing collection's schema
+            if (!existingItem) {
+                return failure({
+                    errorCode: 'record_not_found',
+                    errorMessage: 'Cannot update a database record that does not exist.',
+                });
+            }
+            return success({
+                address: item.address,
+                markers: item.markers,
+                databaseProvider: existingItem.databaseProvider,
+                databaseInfo: existingItem.databaseInfo,
+                databaseName: existingItem.databaseName,
+            });
+        }
+    }
+    async _checkSubscriptionMetrics(action, context, authorization, item) {
+        const config = await this.config.getSubscriptionConfiguration();
+        const metrics = await this.store.getSubscriptionMetrics({
+            ownerId: context.recordOwnerId,
+            studioId: context.recordStudioId,
+        });
+        const features = getDatabaseFeatures(config, metrics.subscriptionStatus, metrics.subscriptionId, metrics.subscriptionType, metrics.currentPeriodStartMs, metrics.currentPeriodEndMs);
+        if (!features.allowed) {
+            return {
+                success: false,
+                errorCode: 'not_authorized',
+                errorMessage: 'Database records are not allowed for this subscription.',
+            };
+        }
+        if (action === 'create' && typeof features.maxItems === 'number') {
+            if (metrics.totalItems >= features.maxItems) {
+                return {
+                    success: false,
+                    errorCode: 'subscription_limit_reached',
+                    errorMessage: 'The maximum number of database record items has been reached for your subscription.',
+                };
+            }
+        }
+        return {
+            success: true,
+            config,
+            metrics,
+            features,
+        };
+    }
+}
+__decorate([
+    traced(TRACE_NAME)
+], DatabaseRecordsController.prototype, "query", null);
+//# sourceMappingURL=DatabaseRecordsController.js.map

package/database/DatabaseRecordsController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseRecordsController.js","sourceRoot":"","sources":["DatabaseRecordsController.ts"],"names":[],"mappings":";;;;;;AAsBA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAY5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAKhD,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAanE,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAEtD,MAAM,UAAU,GAAG,2BAA2B,CAAC;AAuB/C;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,qBAK9C;IAIG,YAAY,MAAoC;QAC5C,KAAK,CAAC;YACF,GAAG,MAAM;YACT,IAAI,EAAE,2BAA2B;YACjC,YAAY,EAAE,UAAU;SAC3B,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,6BAA6B,CAAC;QAC1D,IAAI,CAAC,kBAAkB,GAAG,MAAM,CAAC,iBAAiB,CAAC;IACvD,CAAC;IAGK,AAAN,KAAK,CAAC,KAAK,CACP,OAAsB;;QAEtB,MAAM,WAAW,GAAG;YAChB,qBAAqB,EAAE,OAAO,CAAC,UAAU;YACzC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC/B,CAAC;QAEF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,6BAA6B,CAC7D,WAAW,CACd,CAAC;QAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAC1C,OAAO,CAAC,OAAO,CAAC,UAAU,EAC1B,OAAO,CAAC,OAAO,CAClB,CAAC;QAEF,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,OAAO,CAAC;gBACX,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,gBAAgB;gBAC3B,YAAY,EAAE,yBAAyB;aAC1C,CAAC,CAAC;QACP,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE7B,MAAM,SAAS,GAAmB;YAC9B;gBACI,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,UAAU,EAAE,OAAO,CAAC,OAAO;gBAC3B,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM;aACjB;SACJ,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACpB,SAAS,CAAC,IAAI,CAAC;gBACX,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,UAAU,EAAE,OAAO,CAAC,OAAO;gBAC3B,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,QAAQ;aACnB,CAAC,CAAC;QACP,CAAC;QAED,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,QAAQ,CAAC,qCAAqC,CACrD,OAAO,CAAC,OAAO,EACf;YACI,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,SAAS,EAAE,SAAS;SACvB,CACJ,CAAC;QAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAClC,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC;QAClC,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAC9C,IAAI,CAAC,YAAY,EACjB,OAAO,CAAC,UAAU,EAClB,OAAO,CAAC,QAAQ,EAChB,MAAA,OAAO,CAAC,oBAAoB,mCAAI,IAAI,CACvC,CAAC;QAEF,OAAO,MAAM,CAAC;IAClB,CAAC;IAES,KAAK,CAAC,cAAc,CAC1B,UAAkB,EAClB,OAAe,EACf,IAAoB,EACpB,aAEkD;QAElD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,cAAc,CACrC,UAAU,EACV,OAAO,EACP,IAAI,EACJ,aAAa,CAChB,CAAC;QACF,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YACpB,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEhE,OAAO,OAAO,EAAE,CAAC;IACrB,CAAC;IAES,KAAK,CAAC,oBAAoB,CAChC,IAAoB,EACpB,OAA6B,EAC7B,MAAmB;QAEnB,OAAO;YACH,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACxB,CAAC;IACN,CAAC;IAES,KAAK,CAAC,sBAAsB,CAClC,KAAuB,EACvB,OAA6B,EAC7B,MAAmB;QAEnB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACrB,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,OAAO,EAAE,CAAC,CAAC,OAAO;SACrB,CAAC,CAAC,CAAC;IACR,CAAC;IAES,KAAK,CAAC,mBAAmB,CAC/B,IAAyB,EACzB,YAA4B,EAC5B,MAAmB,EACnB,OAA6B,EAC7B,aAEkD,EAClD,OAAkD;QAElD,IAAI,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC7C,OAAO,OAAO,CAAC;gBACX,SAAS,EAAE,sBAAsB;gBACjC,YAAY,EAAE,eAAe,MAAM,0CAA0C;aAChF,CAAC,CAAC;QACP,CAAC;QAED,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YACtB,MAAM,YAAY,GAAG,IAAI,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,CACzD,YAAY,EACZ;gBACI,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,mBAAmB;aACrD,CACJ,CAAC;YAEF,IAAI,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACtB,OAAO,QAAQ,CAAC;YACpB,CAAC;YAED,OAAO,OAAO,CAAC;gBACX,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,gBAAgB,EAAE,IAAI,CAAC,aAAa;gBACpC,YAAY,EAAE,QAAQ,CAAC,KAAK;gBAC5B,YAAY,EAAE,YAAY;aAC7B,CAAC,CAAC;QACP,CAAC;aAAM,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC7B,kEAAkE;YAClE,IAAI,CAAC,YAAY,EAAE,CAAC;gBAChB,OAAO,OAAO,CAAC;oBACX,SAAS,EAAE,kBAAkB;oBAC7B,YAAY,EACR,sDAAsD;iBAC7D,CAAC,CAAC;YACP,CAAC;YAED,OAAO,OAAO,CAAC;gBACX,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;gBAC/C,YAAY,EAAE,YAAY,CAAC,YAAY;gBACvC,YAAY,EAAE,YAAY,CAAC,YAAY;aAC1C,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAES,KAAK,CAAC,yBAAyB,CACrC,MAAmB,EACnB,OAA6B,EAC7B,aAEkD,EAClD,IAA0B;QAE1B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,4BAA4B,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC;YACpD,OAAO,EAAE,OAAO,CAAC,aAAa;YAC9B,QAAQ,EAAE,OAAO,CAAC,cAAc;SACnC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,mBAAmB,CAChC,MAAM,EACN,OAAO,CAAC,kBAAkB,EAC1B,OAAO,CAAC,cAAc,EACtB,OAAO,CAAC,gBAAgB,EACxB,OAAO,CAAC,oBAAoB,EAC5B,OAAO,CAAC,kBAAkB,CAC7B,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACpB,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,gBAAgB;gBAC3B,YAAY,EACR,yDAAyD;aAChE,CAAC;QACN,CAAC;QAED,IAAI,MAAM,KAAK,QAAQ,IAAI,OAAO,QAAQ,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/D,IAAI,OAAO,CAAC,UAAU,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBAC1C,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,4BAA4B;oBACvC,YAAY,EACR,qFAAqF;iBAC5F,CAAC;YACN,CAAC;QACL,CAAC;QAED,OAAO;YACH,OAAO,EAAE,IAAI;YACb,MAAM;YACN,OAAO;YACP,QAAQ;SACX,CAAC;IACN,CAAC;CACJ;AAlOS;IADL,MAAM,CAAC,UAAU,CAAC;sDAyElB"}

package/database/DatabaseRecordsStore.d.ts

@@ -0,0 +1,40 @@
+import type { CrudRecord, CrudRecordsStore, CrudSubscriptionMetrics } from '../crud';
+import type { SubscriptionFilter } from '../MetricsStore';
+import type { SQliteDatabase, TursoDatabase } from './DatabaseInterface';
+/**
+ * Defines a store that contains search records.
+ */
+export interface DatabaseRecordsStore extends CrudRecordsStore<DatabaseRecord> {
+    /**
+     * Gets the item metrics for the subscription of the given user or studio.
+     * @param filter The filter to use.
+     */
+    getSubscriptionMetrics(filter: SubscriptionFilter): Promise<DatabaseSubscriptionMetrics>;
+}
+/**
+ * Defines a record that represents a database that can be queried using SQL.
+ */
+export interface DatabaseRecord extends CrudRecord {
+    /**
+     * The provider for the database.
+     *
+     * - "turso" the database is stored in turso.
+     * - "sqlite" The database is stored as a local sqlite database file.
+     */
+    databaseProvider: 'turso' | 'sqlite';
+    /**
+     * The info for the database.
+     */
+    databaseInfo: TursoDatabase | SQliteDatabase;
+    /**
+     * The name of the database.
+     */
+    databaseName: string;
+}
+export interface DatabaseSubscriptionMetrics extends CrudSubscriptionMetrics {
+    /**
+     * The total number of database records that are stored in the subscription.
+     */
+    totalItems: number;
+}
+//# sourceMappingURL=DatabaseRecordsStore.d.ts.map

package/database/DatabaseRecordsStore.js

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

package/database/DatabaseRecordsStore.js.map

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

package/database/DatabaseUtils.d.ts

@@ -0,0 +1,12 @@
+import type { DatabaseStatement } from './DatabaseInterface';
+/**
+ * Constructs a database statement from the given query text and parameters.
+ *
+ * Can be used as a tagged template string.
+ *
+ * @param templates The template strings.
+ * @param params The parameters for the query.
+ * @returns
+ */
+export declare function query(templates: TemplateStringsArray, ...params: unknown[]): DatabaseStatement;
+//# sourceMappingURL=DatabaseUtils.d.ts.map

package/database/DatabaseUtils.js

@@ -0,0 +1,33 @@
+/* CasualOS is a set of web-based tools designed to facilitate the creation of real-time, multi-user, context-aware interactive experiences.
+ *
+ * Copyright (c) 2019-2025 Casual Simulation, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+/**
+ * Constructs a database statement from the given query text and parameters.
+ *
+ * Can be used as a tagged template string.
+ *
+ * @param templates The template strings.
+ * @param params The parameters for the query.
+ * @returns
+ */
+export function query(templates, ...params) {
+    return {
+        query: templates.join('?'),
+        params,
+    };
+}
+//# sourceMappingURL=DatabaseUtils.js.map

package/database/DatabaseUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseUtils.js","sourceRoot":"","sources":["DatabaseUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAIH;;;;;;;;GAQG;AACH,MAAM,UAAU,KAAK,CACjB,SAA+B,EAC/B,GAAG,MAAiB;IAEpB,OAAO;QACH,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;QAC1B,MAAM;KACT,CAAC;AACN,CAAC"}

package/database/MemoryDatabaseInterface.d.ts

@@ -0,0 +1,14 @@
+import { type Result, type SimpleError } from '@casual-simulation/aux-common';
+import type { CreateDatabaseOptions, DatabaseInterface, DatabaseStatement, QueryResult, SQliteDatabase } from './DatabaseInterface';
+/**
+ * Defines a database interface that uses in-memory SQLite databases.
+ */
+export declare class MemoryDatabaseInterface implements DatabaseInterface<SQliteDatabase> {
+    private _databases;
+    get databases(): string[];
+    createDatabase(databaseName: string, options: CreateDatabaseOptions): Promise<Result<SQliteDatabase, SimpleError>>;
+    deleteDatabase(databaseName: string): Promise<Result<void, SimpleError>>;
+    query(database: SQliteDatabase, statements: DatabaseStatement[], readonly: boolean, automaticTransaction: boolean): Promise<Result<QueryResult[], SimpleError>>;
+    dispose(): void;
+}
+//# sourceMappingURL=MemoryDatabaseInterface.d.ts.map

package/database/MemoryDatabaseInterface.js

@@ -0,0 +1,119 @@
+/* CasualOS is a set of web-based tools designed to facilitate the creation of real-time, multi-user, context-aware interactive experiences.
+ *
+ * Copyright (c) 2019-2025 Casual Simulation, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import { failure, success, } from '@casual-simulation/aux-common';
+import BetterSQLite3 from 'libsql';
+/**
+ * Defines a database interface that uses in-memory SQLite databases.
+ */
+export class MemoryDatabaseInterface {
+    constructor() {
+        this._databases = new Map();
+    }
+    get databases() {
+        return Array.from(this._databases.keys());
+    }
+    async createDatabase(databaseName, options) {
+        const db = new BetterSQLite3(':memory:');
+        this._databases.set(databaseName, db);
+        return success({
+            filePath: databaseName,
+        });
+    }
+    async deleteDatabase(databaseName) {
+        const db = this._databases.get(databaseName);
+        if (!db) {
+            return failure({
+                errorCode: 'not_found',
+                errorMessage: 'The database was not found.',
+            });
+        }
+        db.close();
+        this._databases.delete(databaseName);
+        return success();
+    }
+    async query(database, statements, readonly, automaticTransaction) {
+        try {
+            const db = this._databases.get(database.filePath);
+            if (!db) {
+                return failure({
+                    errorCode: 'not_found',
+                    errorMessage: 'The database was not found.',
+                });
+            }
+            const results = [];
+            let hasTransaction = false;
+            if (automaticTransaction) {
+                db.exec('BEGIN;');
+                hasTransaction = true;
+            }
+            for (let s of statements) {
+                const q = db.prepare(s.query);
+                if (q.reader) {
+                    q.raw(true);
+                    const columns = q.columns();
+                    const rows = q.all(s.params);
+                    results.push({
+                        columns: columns.map((c) => c.name),
+                        rows,
+                        affectedRowCount: 0,
+                    });
+                }
+                else {
+                    if (readonly && !q.readonly) {
+                        if (hasTransaction) {
+                            db.exec('ROLLBACK;');
+                        }
+                        return failure({
+                            errorCode: 'invalid_request',
+                            errorMessage: 'Queries that modify data are not allowed in read-only mode.',
+                        });
+                    }
+                    const result = q.run(s.params);
+                    results.push({
+                        columns: [],
+                        rows: [],
+                        affectedRowCount: result.changes,
+                        lastInsertId: result.lastInsertRowid || undefined,
+                    });
+                }
+            }
+            if (hasTransaction) {
+                db.exec('COMMIT;');
+            }
+            return success(results);
+        }
+        catch (err) {
+            if (err instanceof BetterSQLite3.SqliteError) {
+                return failure({
+                    errorCode: 'invalid_request',
+                    errorMessage: err.message,
+                });
+            }
+            else {
+                throw err;
+            }
+        }
+    }
+    dispose() {
+        for (let db of this._databases.values()) {
+            db.close();
+        }
+        this._databases.clear();
+    }
+}
+//# sourceMappingURL=MemoryDatabaseInterface.js.map

package/database/MemoryDatabaseInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryDatabaseInterface.js","sourceRoot":"","sources":["MemoryDatabaseInterface.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EACH,OAAO,EACP,OAAO,GAGV,MAAM,+BAA+B,CAAC;AAQvC,OAAO,aAAa,MAAM,QAAQ,CAAC;AAEnC;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAApC;QAGY,eAAU,GAAwC,IAAI,GAAG,EAAE,CAAC;IAqHxE,CAAC;IAnHG,IAAI,SAAS;QACT,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,cAAc,CAChB,YAAoB,EACpB,OAA8B;QAE9B,MAAM,EAAE,GAAG,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QACtC,OAAO,OAAO,CAAC;YACX,QAAQ,EAAE,YAAY;SACzB,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,cAAc,CAChB,YAAoB;QAEpB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC7C,IAAI,CAAC,EAAE,EAAE,CAAC;YACN,OAAO,OAAO,CAAC;gBACX,SAAS,EAAE,WAAW;gBACtB,YAAY,EAAE,6BAA6B;aAC9C,CAAC,CAAC;QACP,CAAC;QACD,EAAE,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACrC,OAAO,OAAO,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,KAAK,CACP,QAAwB,EACxB,UAA+B,EAC/B,QAAiB,EACjB,oBAA6B;QAE7B,IAAI,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAElD,IAAI,CAAC,EAAE,EAAE,CAAC;gBACN,OAAO,OAAO,CAAC;oBACX,SAAS,EAAE,WAAW;oBACtB,YAAY,EAAE,6BAA6B;iBAC9C,CAAC,CAAC;YACP,CAAC;YAED,MAAM,OAAO,GAAkB,EAAE,CAAC;YAElC,IAAI,cAAc,GAAG,KAAK,CAAC;YAC3B,IAAI,oBAAoB,EAAE,CAAC;gBACvB,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAClB,cAAc,GAAG,IAAI,CAAC;YAC1B,CAAC;YAED,KAAK,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvB,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBAE9B,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;oBACX,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBACZ,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;oBAC5B,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;oBAE7B,OAAO,CAAC,IAAI,CAAC;wBACT,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;wBACnC,IAAI;wBACJ,gBAAgB,EAAE,CAAC;qBACtB,CAAC,CAAC;gBACP,CAAC;qBAAM,CAAC;oBACJ,IAAI,QAAQ,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;wBAC1B,IAAI,cAAc,EAAE,CAAC;4BACjB,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;wBACzB,CAAC;wBAED,OAAO,OAAO,CAAC;4BACX,SAAS,EAAE,iBAAiB;4BAC5B,YAAY,EACR,6DAA6D;yBACrD,CAAC,CAAC;oBACtB,CAAC;oBAED,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;oBAE/B,OAAO,CAAC,IAAI,CAAC;wBACT,OAAO,EAAE,EAAE;wBACX,IAAI,EAAE,EAAE;wBACR,gBAAgB,EAAE,MAAM,CAAC,OAAO;wBAChC,YAAY,EACP,MAAM,CAAC,eAAuB,IAAI,SAAS;qBACnD,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;YAED,IAAI,cAAc,EAAE,CAAC;gBACjB,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvB,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,GAAG,YAAY,aAAa,CAAC,WAAW,EAAE,CAAC;gBAC3C,OAAO,OAAO,CAAC;oBACX,SAAS,EAAE,iBAAiB;oBAC5B,YAAY,EAAE,GAAG,CAAC,OAAO;iBAC5B,CAAC,CAAC;YACP,CAAC;iBAAM,CAAC;gBACJ,MAAM,GAAG,CAAC;YACd,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO;QACH,KAAK,IAAI,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;YACtC,EAAE,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;CACJ"}

package/database/MemoryDatabaseRecordsStore.d.ts

@@ -0,0 +1,10 @@
+import { MemoryCrudRecordsStore } from '../crud/MemoryCrudRecordsStore';
+import type { SubscriptionFilter } from '../MetricsStore';
+import type { DatabaseRecord, DatabaseRecordsStore, DatabaseSubscriptionMetrics } from './DatabaseRecordsStore';
+/**
+ * A Memory-based implementation of the DatabaseRecordsStore.
+ */
+export declare class MemoryDatabaseRecordsStore extends MemoryCrudRecordsStore<DatabaseRecord> implements DatabaseRecordsStore {
+    getSubscriptionMetrics(filter: SubscriptionFilter): Promise<DatabaseSubscriptionMetrics>;
+}
+//# sourceMappingURL=MemoryDatabaseRecordsStore.d.ts.map

package/database/MemoryDatabaseRecordsStore.js

@@ -0,0 +1,38 @@
+/* CasualOS is a set of web-based tools designed to facilitate the creation of real-time, multi-user, context-aware interactive experiences.
+ *
+ * Copyright (c) 2019-2025 Casual Simulation, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import { MemoryCrudRecordsStore } from '../crud/MemoryCrudRecordsStore';
+/**
+ * A Memory-based implementation of the DatabaseRecordsStore.
+ */
+export class MemoryDatabaseRecordsStore extends MemoryCrudRecordsStore {
+    async getSubscriptionMetrics(filter) {
+        const info = await super.getSubscriptionMetrics(filter);
+        let totalItems = 0;
+        const records = filter.ownerId
+            ? await this.store.listRecordsByOwnerId(filter.ownerId)
+            : await this.store.listRecordsByStudioId(filter.studioId);
+        for (let record of records) {
+            totalItems += this.getItemRecord(record.name).size;
+        }
+        return {
+            ...info,
+            totalItems,
+        };
+    }
+}
+//# sourceMappingURL=MemoryDatabaseRecordsStore.js.map

package/database/MemoryDatabaseRecordsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryDatabaseRecordsStore.js","sourceRoot":"","sources":["MemoryDatabaseRecordsStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAQxE;;GAEG;AACH,MAAM,OAAO,0BACT,SAAQ,sBAAsC;IAG9C,KAAK,CAAC,sBAAsB,CACxB,MAA0B;QAE1B,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QAExD,IAAI,UAAU,GAAG,CAAC,CAAC;QAEnB,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO;YAC1B,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC;YACvD,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAS,CAAC,CAAC;QAC/D,KAAK,IAAI,MAAM,IAAI,OAAO,EAAE,CAAC;YACzB,UAAU,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QACvD,CAAC;QAED,OAAO;YACH,GAAG,IAAI;YACP,UAAU;SACb,CAAC;IACN,CAAC;CACJ"}

package/database/SqliteDatabaseInterface.d.ts

@@ -0,0 +1,16 @@
+import { type Result, type SimpleError } from '@casual-simulation/aux-common';
+import type { CreateDatabaseOptions, DatabaseInterface, DatabaseStatement, QueryResult, SQliteDatabase } from './DatabaseInterface';
+/**
+ * Defines a database interface that uses in-memory SQLite databases.
+ */
+export declare class SqliteDatabaseInterface implements DatabaseInterface<SQliteDatabase> {
+    #private;
+    private _folderPath;
+    constructor(folder: string, encryptionKey?: string | null);
+    createDatabase(databaseName: string, options: CreateDatabaseOptions): Promise<Result<SQliteDatabase, SimpleError>>;
+    private _getDatabasePath;
+    deleteDatabase(databaseName: string): Promise<Result<void, SimpleError>>;
+    query(database: SQliteDatabase, statements: DatabaseStatement[], readonly: boolean, automaticTransaction: boolean): Promise<Result<QueryResult[], SimpleError>>;
+    dispose(): void;
+}
+//# sourceMappingURL=SqliteDatabaseInterface.d.ts.map