@casual-simulation/aux-records 3.4.6-alpha.14601027727 → 3.5.0-alpha.15117651144

package/crud/sub/SubCrudRecordsController.d.ts

@@ -0,0 +1,182 @@
+import type { AuthorizationContext, AuthorizeUserAndInstancesForResourcesSuccess, AuthorizeUserAndInstancesSuccess, PolicyController } from '../../PolicyController';
+import type { ConfigurationStore } from '../../ConfigurationStore';
+import type { ActionKinds, ResourceKinds } from '@casual-simulation/aux-common';
+import type { SubCrudRecord, SubCrudRecordsStore } from './SubCrudRecordsStore';
+import type { CrudRecord, CrudRecordsStore } from '../CrudRecordsStore';
+import type { CheckSubscriptionMetricsResult, CrudEraseItemResult, CrudGetItemResult, CrudListItemsResult, CrudRecordItemRequest, CrudRecordItemResult } from '../CrudRecordsController';
+export interface SubCrudRecordsConfiguration<TKey, T extends SubCrudRecord<TKey>, TStore extends SubCrudRecordsStore<TKey, T> = SubCrudRecordsStore<TKey, T>, TRecordStore extends CrudRecordsStore<CrudRecord> = CrudRecordsStore<CrudRecord>> {
+    /**
+     * The name for the controller.
+     */
+    name: string;
+    /**
+     * The store that the controller uses.
+     */
+    store: TStore;
+    /**
+     * The record item store that the controller uses.
+     */
+    recordItemStore: TRecordStore;
+    /**
+     * The policy controller.
+     */
+    policies: PolicyController;
+    /**
+     * The configuration store.
+     */
+    config: ConfigurationStore;
+    /**
+     * The kind of resource that the controller is for.
+     */
+    resourceKind: ResourceKinds;
+}
+/**
+ * Defines a controller that can be used to present a CRUD API for a record.
+ *
+ * This controller is designed to be a base class that can be extended to make basic Create, Read, Update, and Delete operations on items in a record.
+ *
+ * @param TKey The type of the key for each item stored by this controller.
+ * @param T The type of the records that the controller can manage.
+ * @param TMetrics The type of the metrics that the controller can provide.
+ * @param TStore The type of the store that the controller uses.
+ * @param TRecordStore The type of the store that the controller uses for record items.
+ * @param TResult The type of the result that the controller returns to clients. Must be a subset of T.
+ */
+export declare abstract class SubCrudRecordsController<TKey, T extends SubCrudRecord<TKey>, TStore extends SubCrudRecordsStore<TKey, T> = SubCrudRecordsStore<TKey, T>, TRecordStore extends CrudRecordsStore<CrudRecord> = CrudRecordsStore<CrudRecord>, TResult extends Partial<T> = T> {
+    private _store;
+    private _recordStore;
+    private _policies;
+    private _config;
+    private _name;
+    private _resourceKind;
+    protected get config(): ConfigurationStore;
+    /**
+     * Gets the name of the controller.
+     */
+    get name(): string;
+    protected get policies(): PolicyController;
+    protected get store(): TStore;
+    /**
+     * Gets the kind of resources that this controller is for.
+     */
+    get resourceKind(): ResourceKinds;
+    constructor(config: SubCrudRecordsConfiguration<TKey, T, TStore, TRecordStore>);
+    /**
+     * Creates or updates an item in the given record.
+     * @param request The request.
+     */
+    recordItem(request: CrudRecordItemRequest<T>): Promise<CrudRecordItemResult>;
+    /**
+     * Updates or creates the item in the given record.
+     * @param action The action that is being performed.
+     * @param recordName The name of the record.
+     * @param item The item that should be updated or created.
+     * @param context The authorization context.
+     * @param authorization The authorization for the user and instances.
+     * @param request The request.
+     */
+    protected _putItem(action: 'update' | 'create', recordName: string, item: T, context: AuthorizationContext, authorization: AuthorizeUserAndInstancesForResourcesSuccess, request: CrudRecordItemRequest<T>): Promise<CrudRecordItemResult>;
+    /**
+     * Gets the item with the given address from the given record.
+     * @param request The request to get the item.
+     */
+    getItem(request: SubCrudGetItemRequest<TKey>): Promise<CrudGetItemResult<TResult>>;
+    /**
+     * Deletes the item with the given address from the given record.
+     * @param request The request.
+     */
+    eraseItem(request: SubCrudEraseItemRequest<TKey>): Promise<CrudEraseItemResult>;
+    /**
+     * Lists items in the given record.
+     * @param request The request.
+     */
+    listItems(request: SubCrudListItemsRequest): Promise<CrudListItemsResult<TResult>>;
+    /**
+     * Checks that the given metrics are valid for the subscription.
+     * @param metrics The metrics that were fetched from the database.
+     * @param action The action that is being performed.
+     * @param authorization The authorization for the user and instances.
+     * @param item The item that should be checked. Omitted for delete actions.
+     */
+    protected abstract _checkSubscriptionMetrics(action: ActionKinds, context: AuthorizationContext, authorization: AuthorizeUserAndInstancesSuccess | AuthorizeUserAndInstancesForResourcesSuccess, item?: T): Promise<CheckSubscriptionMetricsResult>;
+    /**
+     * Converts the given item to a version that is able to be returned to clients.
+     * Can be overriden to ensure that some fields are not returned.
+     * @param item The item that should be converted.
+     * @param context The authorization context.
+     * @returns The converted item.
+     */
+    protected _convertItemToResult(item: T, context: AuthorizationContext): TResult;
+    /**
+     * Transforms the given input item and returns the transformed item.
+     * Useful for transforming items before they are stored.
+     * @param item The item that should be transformed.
+     */
+    protected _transformInputItem(item: T): T;
+}
+export interface SubCrudGetItemRequest<TKey> {
+    /**
+     * The name of the record that the request is for.
+     * Can also be a record key.
+     */
+    recordName: string;
+    /**
+     * The address of the record item that the item is stored in.
+     */
+    address: string;
+    /**
+     * The key of the item to get.
+     */
+    key: TKey;
+    /**
+     * The ID of the user who is currently logged in.
+     */
+    userId: string;
+    /**
+     * The instances that the request is coming from.
+     */
+    instances: string[];
+}
+export interface SubCrudEraseItemRequest<TKey> {
+    /**
+     * The name of the record that the request is for.
+     * Can also be a record key.
+     */
+    recordName: string;
+    /**
+     * The address of the item that should be erased.
+     */
+    address: string;
+    /**
+     * The key of the item that should be erased.
+     */
+    key: TKey;
+    /**
+     * The ID of the user who is currently logged in.
+     */
+    userId: string;
+    /**
+     * The instances that the request is coming from.
+     */
+    instances: string[];
+}
+export interface SubCrudListItemsRequest {
+    /**
+     * The name of the record that the request is for.
+     * Can also be a record key.
+     */
+    recordName: string;
+    /**
+     * The address that the items should be listed for.
+     */
+    address: string;
+    /**
+     * The ID of the user who is currently logged in.
+     */
+    userId: string;
+    /**
+     * The instances that the request is coming from.
+     */
+    instances: string[];
+}
+//# sourceMappingURL=SubCrudRecordsController.d.ts.map

package/crud/sub/SubCrudRecordsController.js

@@ -0,0 +1,360 @@
+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 { traced } from '../../tracing/TracingDecorators';
+import { SpanStatusCode, trace } from '@opentelemetry/api';
+const TRACE_NAME = 'SubCrudRecordsController';
+/**
+ * Defines a controller that can be used to present a CRUD API for a record.
+ *
+ * This controller is designed to be a base class that can be extended to make basic Create, Read, Update, and Delete operations on items in a record.
+ *
+ * @param TKey The type of the key for each item stored by this controller.
+ * @param T The type of the records that the controller can manage.
+ * @param TMetrics The type of the metrics that the controller can provide.
+ * @param TStore The type of the store that the controller uses.
+ * @param TRecordStore The type of the store that the controller uses for record items.
+ * @param TResult The type of the result that the controller returns to clients. Must be a subset of T.
+ */
+export class SubCrudRecordsController {
+    get config() {
+        return this._config;
+    }
+    /**
+     * Gets the name of the controller.
+     */
+    get name() {
+        return this._name;
+    }
+    get policies() {
+        return this._policies;
+    }
+    get store() {
+        return this._store;
+    }
+    /**
+     * Gets the kind of resources that this controller is for.
+     */
+    get resourceKind() {
+        return this._resourceKind;
+    }
+    constructor(config) {
+        this._name = config.name;
+        this._store = config.store;
+        this._recordStore = config.recordItemStore;
+        this._policies = config.policies;
+        this._config = config.config;
+        this._resourceKind = config.resourceKind;
+    }
+    /**
+     * Creates or updates an item in the given record.
+     * @param request The request.
+     */
+    async recordItem(request) {
+        try {
+            const contextResult = await this._policies.constructAuthorizationContext({
+                recordKeyOrRecordName: request.recordKeyOrRecordName,
+                userId: request.userId,
+            });
+            if (contextResult.success === false) {
+                return contextResult;
+            }
+            const recordName = contextResult.context.recordName;
+            const existingItem = await this._store.getItemByKey(recordName, request.item.address, request.item.key);
+            if (!existingItem.parentMarkers) {
+                return {
+                    success: false,
+                    errorCode: 'data_not_found',
+                    errorMessage: 'The parent item was not found.',
+                };
+            }
+            let resourceMarkers = existingItem.parentMarkers;
+            let action = existingItem.item
+                ? 'update'
+                : 'create';
+            let authorization;
+            if (action === 'update') {
+                action = 'update';
+                authorization =
+                    await this._policies.authorizeUserAndInstancesForResources(contextResult.context, {
+                        userId: request.userId,
+                        instances: request.instances,
+                        resources: [
+                            {
+                                resourceKind: this._resourceKind,
+                                resourceId: existingItem.item.address,
+                                action: action,
+                                markers: resourceMarkers,
+                            },
+                        ],
+                    });
+                if (authorization.success === false) {
+                    return authorization;
+                }
+            }
+            else {
+                authorization =
+                    await this._policies.authorizeUserAndInstancesForResources(contextResult.context, {
+                        userId: request.userId,
+                        instances: request.instances,
+                        resources: [
+                            {
+                                resourceKind: this._resourceKind,
+                                resourceId: request.item.address,
+                                action: action,
+                                markers: resourceMarkers,
+                            },
+                        ],
+                    });
+                if (authorization.success === false) {
+                    return authorization;
+                }
+            }
+            if (!resourceMarkers) {
+                return {
+                    success: false,
+                    errorCode: 'invalid_request',
+                    errorMessage: 'The item must have markers.',
+                };
+            }
+            const item = this._transformInputItem(request.item);
+            const subscriptionResult = await this._checkSubscriptionMetrics(action, contextResult.context, authorization, item);
+            if (subscriptionResult.success === false) {
+                return subscriptionResult;
+            }
+            const result = await this._putItem(action, recordName, item, contextResult.context, authorization, request);
+            return result;
+        }
+        catch (err) {
+            const span = trace.getActiveSpan();
+            span === null || span === void 0 ? void 0 : span.recordException(err);
+            span === null || span === void 0 ? void 0 : span.setStatus({ code: SpanStatusCode.ERROR });
+            console.error(`[${this._name}] Error recording item:`, err);
+            return {
+                success: false,
+                errorCode: 'server_error',
+                errorMessage: 'A server error occurred.',
+            };
+        }
+    }
+    /**
+     * Updates or creates the item in the given record.
+     * @param action The action that is being performed.
+     * @param recordName The name of the record.
+     * @param item The item that should be updated or created.
+     * @param context The authorization context.
+     * @param authorization The authorization for the user and instances.
+     * @param request The request.
+     */
+    async _putItem(action, recordName, item, context, authorization, request) {
+        const crudResult = await this._store.putItem(recordName, item);
+        if (crudResult.success === false) {
+            return crudResult;
+        }
+        return {
+            success: true,
+            recordName,
+            address: item.address,
+        };
+    }
+    /**
+     * Gets the item with the given address from the given record.
+     * @param request The request to get the item.
+     */
+    async getItem(request) {
+        try {
+            const baseRequest = {
+                recordKeyOrRecordName: request.recordName,
+                userId: request.userId,
+                instances: request.instances,
+            };
+            const context = await this._policies.constructAuthorizationContext(baseRequest);
+            if (context.success === false) {
+                return context;
+            }
+            const result = await this._store.getItemByKey(context.context.recordName, request.address, request.key);
+            if (!result.item) {
+                return {
+                    success: false,
+                    errorCode: 'data_not_found',
+                    errorMessage: 'The item was not found.',
+                };
+            }
+            const markers = result.parentMarkers;
+            const authorization = await this._policies.authorizeUserAndInstances(context.context, {
+                userId: request.userId,
+                instances: request.instances,
+                resourceKind: this._resourceKind,
+                resourceId: request.address,
+                action: 'read',
+                markers: markers,
+            });
+            if (authorization.success === false) {
+                return authorization;
+            }
+            const item = result.item;
+            const metricsResult = await this._checkSubscriptionMetrics('read', context.context, authorization, item);
+            if (metricsResult.success === false) {
+                return metricsResult;
+            }
+            return {
+                success: true,
+                item: this._convertItemToResult(item, context.context),
+            };
+        }
+        catch (err) {
+            const span = trace.getActiveSpan();
+            span === null || span === void 0 ? void 0 : span.recordException(err);
+            span === null || span === void 0 ? void 0 : span.setStatus({ code: SpanStatusCode.ERROR });
+            console.error(`[${this._name}] Error getting item:`, err);
+            return {
+                success: false,
+                errorCode: 'server_error',
+                errorMessage: 'A server error occurred.',
+            };
+        }
+    }
+    /**
+     * Deletes the item with the given address from the given record.
+     * @param request The request.
+     */
+    async eraseItem(request) {
+        try {
+            const context = await this._policies.constructAuthorizationContext({
+                recordKeyOrRecordName: request.recordName,
+                userId: request.userId,
+            });
+            if (context.success === false) {
+                return context;
+            }
+            const result = await this._store.getItemByKey(context.context.recordName, request.address, request.key);
+            if (!result.item) {
+                return {
+                    success: false,
+                    errorCode: 'data_not_found',
+                    errorMessage: 'The item was not found.',
+                };
+            }
+            const markers = result.parentMarkers;
+            const authorization = await this._policies.authorizeUserAndInstances(context.context, {
+                userId: request.userId,
+                instances: request.instances,
+                resourceKind: this._resourceKind,
+                resourceId: request.address,
+                action: 'delete',
+                markers,
+            });
+            if (authorization.success === false) {
+                return authorization;
+            }
+            const recordName = context.context.recordName;
+            const subscriptionResult = await this._checkSubscriptionMetrics('delete', context.context, authorization);
+            if (subscriptionResult.success === false) {
+                return subscriptionResult;
+            }
+            await this._store.deleteItem(recordName, request.address, request.key);
+            return {
+                success: true,
+            };
+        }
+        catch (err) {
+            const span = trace.getActiveSpan();
+            span === null || span === void 0 ? void 0 : span.recordException(err);
+            span === null || span === void 0 ? void 0 : span.setStatus({ code: SpanStatusCode.ERROR });
+            console.error(`[${this._name}] Error erasing item:`, err);
+            return {
+                success: false,
+                errorCode: 'server_error',
+                errorMessage: 'A server error occurred.',
+            };
+        }
+    }
+    /**
+     * Lists items in the given record.
+     * @param request The request.
+     */
+    async listItems(request) {
+        try {
+            const baseRequest = {
+                recordKeyOrRecordName: request.recordName,
+                userId: request.userId,
+                instances: request.instances,
+            };
+            const context = await this._policies.constructAuthorizationContext(baseRequest);
+            if (context.success === false) {
+                return context;
+            }
+            const recordName = context.context.recordName;
+            const item = await this._recordStore.getItemByAddress(recordName, request.address);
+            if (!item) {
+                return {
+                    success: false,
+                    errorCode: 'data_not_found',
+                    errorMessage: 'The parent item was not found.',
+                };
+            }
+            const authorization = await this._policies.authorizeUserAndInstances(context.context, {
+                userId: request.userId,
+                instances: request.instances,
+                resourceKind: this._resourceKind,
+                action: 'list',
+                markers: item.markers,
+            });
+            if (authorization.success === false) {
+                return authorization;
+            }
+            const result2 = await this._store.listItems(context.context.recordName, request.address);
+            return {
+                success: true,
+                recordName: context.context.recordName,
+                items: result2.items.map((item) => this._convertItemToResult(item, context.context)),
+                totalCount: result2.totalCount,
+            };
+        }
+        catch (err) {
+            const span = trace.getActiveSpan();
+            span === null || span === void 0 ? void 0 : span.recordException(err);
+            span === null || span === void 0 ? void 0 : span.setStatus({ code: SpanStatusCode.ERROR });
+            console.error(`[${this._name}] Error listing items:`, err);
+            return {
+                success: false,
+                errorCode: 'server_error',
+                errorMessage: 'A server error occurred.',
+            };
+        }
+    }
+    /**
+     * Converts the given item to a version that is able to be returned to clients.
+     * Can be overriden to ensure that some fields are not returned.
+     * @param item The item that should be converted.
+     * @param context The authorization context.
+     * @returns The converted item.
+     */
+    _convertItemToResult(item, context) {
+        return item;
+    }
+    /**
+     * Transforms the given input item and returns the transformed item.
+     * Useful for transforming items before they are stored.
+     * @param item The item that should be transformed.
+     */
+    _transformInputItem(item) {
+        return item;
+    }
+}
+__decorate([
+    traced(TRACE_NAME)
+], SubCrudRecordsController.prototype, "recordItem", null);
+__decorate([
+    traced(TRACE_NAME)
+], SubCrudRecordsController.prototype, "getItem", null);
+__decorate([
+    traced(TRACE_NAME)
+], SubCrudRecordsController.prototype, "eraseItem", null);
+__decorate([
+    traced(TRACE_NAME)
+], SubCrudRecordsController.prototype, "listItems", null);
+//# sourceMappingURL=SubCrudRecordsController.js.map

package/crud/sub/SubCrudRecordsController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubCrudRecordsController.js","sourceRoot":"","sources":["SubCrudRecordsController.ts"],"names":[],"mappings":";;;;;;AA4BA,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAiD3D,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAE9C;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,wBAAwB;IAc1C,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,IAAc,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,IAAc,KAAK;QACf,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;IAED,YACI,MAAkE;QAElE,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,eAAe,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC;IAC7C,CAAC;IAED;;;OAGG;IAEG,AAAN,KAAK,CAAC,UAAU,CACZ,OAAiC;QAEjC,IAAI,CAAC;YACD,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAAC;gBAC/C,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;gBACpD,MAAM,EAAE,OAAO,CAAC,MAAM;aACzB,CAAC,CAAC;YAEP,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAClC,OAAO,aAAa,CAAC;YACzB,CAAC;YAED,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC;YACpD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAC/C,UAAU,EACV,OAAO,CAAC,IAAI,CAAC,OAAO,EACpB,OAAO,CAAC,IAAI,CAAC,GAAG,CACnB,CAAC;YAEF,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;gBAC9B,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,gBAAgB;oBAC3B,YAAY,EAAE,gCAAgC;iBACjD,CAAC;YACN,CAAC;YAED,IAAI,eAAe,GAAG,YAAY,CAAC,aAAa,CAAC;YAEjD,IAAI,MAAM,GAAG,YAAY,CAAC,IAAI;gBAC1B,CAAC,CAAE,QAAkB;gBACrB,CAAC,CAAE,QAAkB,CAAC;YAC1B,IAAI,aAA0D,CAAC;YAC/D,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACtB,MAAM,GAAG,QAAQ,CAAC;gBAClB,aAAa;oBACT,MAAM,IAAI,CAAC,SAAS,CAAC,qCAAqC,CACtD,aAAa,CAAC,OAAO,EACrB;wBACI,MAAM,EAAE,OAAO,CAAC,MAAM;wBACtB,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,SAAS,EAAE;4BACP;gCACI,YAAY,EAAE,IAAI,CAAC,aAAa;gCAChC,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO;gCACrC,MAAM,EAAE,MAAM;gCACd,OAAO,EAAE,eAAe;6BAC3B;yBACJ;qBACJ,CACJ,CAAC;gBAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;oBAClC,OAAO,aAAa,CAAC;gBACzB,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,aAAa;oBACT,MAAM,IAAI,CAAC,SAAS,CAAC,qCAAqC,CACtD,aAAa,CAAC,OAAO,EACrB;wBACI,MAAM,EAAE,OAAO,CAAC,MAAM;wBACtB,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,SAAS,EAAE;4BACP;gCACI,YAAY,EAAE,IAAI,CAAC,aAAa;gCAChC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO;gCAChC,MAAM,EAAE,MAAM;gCACd,OAAO,EAAE,eAAe;6BAC3B;yBACJ;qBACJ,CACJ,CAAC;gBAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;oBAClC,OAAO,aAAa,CAAC;gBACzB,CAAC;YACL,CAAC;YAED,IAAI,CAAC,eAAe,EAAE,CAAC;gBACnB,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,iBAAiB;oBAC5B,YAAY,EAAE,6BAA6B;iBAC9C,CAAC;YACN,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpD,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAC3D,MAAM,EACN,aAAa,CAAC,OAAO,EACrB,aAAa,EACb,IAAI,CACP,CAAC;YAEF,IAAI,kBAAkB,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBACvC,OAAO,kBAAkB,CAAC;YAC9B,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAC9B,MAAM,EACN,UAAU,EACV,IAAI,EACJ,aAAa,CAAC,OAAO,EACrB,aAAa,EACb,OAAO,CACV,CAAC;YACF,OAAO,MAAM,CAAC;QAClB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;YACnC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;YAEhD,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAC5D,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,cAAc;gBACzB,YAAY,EAAE,0BAA0B;aAC3C,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACO,KAAK,CAAC,QAAQ,CACpB,MAA2B,EAC3B,UAAkB,EAClB,IAAO,EACP,OAA6B,EAC7B,aAA2D,EAC3D,OAAiC;QAEjC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAE/D,IAAI,UAAU,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC/B,OAAO,UAAU,CAAC;QACtB,CAAC;QAED,OAAO;YACH,OAAO,EAAE,IAAI;YACb,UAAU;YACV,OAAO,EAAE,IAAI,CAAC,OAAO;SACxB,CAAC;IACN,CAAC;IAED;;;OAGG;IAEG,AAAN,KAAK,CAAC,OAAO,CACT,OAAoC;QAEpC,IAAI,CAAC;YACD,MAAM,WAAW,GAAG;gBAChB,qBAAqB,EAAE,OAAO,CAAC,UAAU;gBACzC,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,SAAS,EAAE,OAAO,CAAC,SAAS;aAC/B,CAAC;YAEF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC9D,WAAW,CACd,CAAC;YAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAC5B,OAAO,OAAO,CAAC;YACnB,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CACzC,OAAO,CAAC,OAAO,CAAC,UAAU,EAC1B,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,GAAG,CACd,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACf,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,gBAAgB;oBAC3B,YAAY,EAAE,yBAAyB;iBAC1C,CAAC;YACN,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC;YACrC,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAC1C,OAAO,CAAC,OAAO,EACf;gBACI,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,YAAY,EAAE,IAAI,CAAC,aAAa;gBAChC,UAAU,EAAE,OAAO,CAAC,OAAO;gBAC3B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,OAAO;aACnB,CACJ,CAAC;YAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAClC,OAAO,aAAa,CAAC;YACzB,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACzB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CACtD,MAAM,EACN,OAAO,CAAC,OAAO,EACf,aAAa,EACb,IAAI,CACP,CAAC;YAEF,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAClC,OAAO,aAAa,CAAC;YACzB,CAAC;YAED,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC;aACzD,CAAC;QACN,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;YACnC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;YAEhD,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAC1D,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,cAAc;gBACzB,YAAY,EAAE,0BAA0B;aAC3C,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;OAGG;IAEG,AAAN,KAAK,CAAC,SAAS,CACX,OAAsC;QAEtC,IAAI,CAAC;YACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAAC;gBAC/D,qBAAqB,EAAE,OAAO,CAAC,UAAU;gBACzC,MAAM,EAAE,OAAO,CAAC,MAAM;aACzB,CAAC,CAAC;YAEH,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAC5B,OAAO,OAAO,CAAC;YACnB,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CACzC,OAAO,CAAC,OAAO,CAAC,UAAU,EAC1B,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,GAAG,CACd,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACf,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,gBAAgB;oBAC3B,YAAY,EAAE,yBAAyB;iBAC1C,CAAC;YACN,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC;YAErC,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAC1C,OAAO,CAAC,OAAO,EACf;gBACI,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,YAAY,EAAE,IAAI,CAAC,aAAa;gBAChC,UAAU,EAAE,OAAO,CAAC,OAAO;gBAC3B,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACV,CACJ,CAAC;YAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAClC,OAAO,aAAa,CAAC;YACzB,CAAC;YAED,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;YAC9C,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAC3D,QAAQ,EACR,OAAO,CAAC,OAAO,EACf,aAAa,CAChB,CAAC;YAEF,IAAI,kBAAkB,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBACvC,OAAO,kBAAkB,CAAC;YAC9B,CAAC;YAED,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CACxB,UAAU,EACV,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,GAAG,CACd,CAAC;YAEF,OAAO;gBACH,OAAO,EAAE,IAAI;aAChB,CAAC;QACN,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;YACnC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;YAEhD,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAC1D,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,cAAc;gBACzB,YAAY,EAAE,0BAA0B;aAC3C,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;OAGG;IAEG,AAAN,KAAK,CAAC,SAAS,CACX,OAAgC;QAEhC,IAAI,CAAC;YACD,MAAM,WAAW,GAAG;gBAChB,qBAAqB,EAAE,OAAO,CAAC,UAAU;gBACzC,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,SAAS,EAAE,OAAO,CAAC,SAAS;aAC/B,CAAC;YACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC9D,WAAW,CACd,CAAC;YAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAC5B,OAAO,OAAO,CAAC;YACnB,CAAC;YAED,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,CACjD,UAAU,EACV,OAAO,CAAC,OAAO,CAClB,CAAC;YAEF,IAAI,CAAC,IAAI,EAAE,CAAC;gBACR,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,gBAAgB;oBAC3B,YAAY,EAAE,gCAAgC;iBACjD,CAAC;YACN,CAAC;YAED,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAC1C,OAAO,CAAC,OAAO,EACf;gBACI,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,YAAY,EAAE,IAAI,CAAC,aAAa;gBAChC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI,CAAC,OAAO;aACxB,CACJ,CAAC;YAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAClC,OAAO,aAAa,CAAC;YACzB,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CACvC,OAAO,CAAC,OAAO,CAAC,UAAU,EAC1B,OAAO,CAAC,OAAO,CAClB,CAAC;YAEF,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU;gBACtC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC9B,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CACnD;gBACD,UAAU,EAAE,OAAO,CAAC,UAAU;aACjC,CAAC;QACN,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;YACnC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;YAEhD,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,wBAAwB,EAAE,GAAG,CAAC,CAAC;YAC3D,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,cAAc;gBACzB,YAAY,EAAE,0BAA0B;aAC3C,CAAC;QACN,CAAC;IACL,CAAC;IAkBD;;;;;;OAMG;IACO,oBAAoB,CAC1B,IAAO,EACP,OAA6B;QAE7B,OAAO,IAA0B,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACO,mBAAmB,CAAC,IAAO;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAxbS;IADL,MAAM,CAAC,UAAU,CAAC;0DA0HlB;AAqCK;IADL,MAAM,CAAC,UAAU,CAAC;uDA+ElB;AAOK;IADL,MAAM,CAAC,UAAU,CAAC;yDA+ElB;AAOK;IADL,MAAM,CAAC,UAAU,CAAC;yDAyElB"}

package/crud/sub/SubCrudRecordsControllerTests.d.ts

@@ -0,0 +1,39 @@
+import type { MemoryStore } from '../../MemoryStore';
+import type { SubCrudRecordsConfiguration, SubCrudRecordsController } from './SubCrudRecordsController';
+import type { CrudRecord, CrudRecordsStore } from '../CrudRecordsStore';
+import { createTestControllers } from '../../TestUtils';
+import type { ActionKinds, ResourceKinds } from '@casual-simulation/aux-common';
+import type { SubCrudRecord, SubCrudRecordsStore } from './SubCrudRecordsStore';
+export type TestControllers = ReturnType<typeof createTestControllers>;
+export type TestControllerConfiguration<TKey, TItem extends SubCrudRecord<TKey>, TStore extends SubCrudRecordsStore<TKey, TItem>, TRecordStore extends CrudRecordsStore<CrudRecord>> = Omit<SubCrudRecordsConfiguration<TKey, TItem, TStore, TRecordStore>, 'resourceKind' | 'allowRecordKeys' | 'name'>;
+export interface TestContext<TKey, TItem extends SubCrudRecord<TKey>, TStore extends SubCrudRecordsStore<TKey, TItem>, TRecordStore extends CrudRecordsStore<CrudRecord>, TController extends SubCrudRecordsController<TKey, TItem, TStore, TRecordStore>> {
+    services: TestControllers;
+    store: MemoryStore;
+    itemsStore: TStore;
+    recordItemsStore: TRecordStore;
+    manager: TController;
+    userId: string;
+    sessionKey: string;
+    otherUserId: string;
+    key: string;
+    subjectlessKey: string;
+    recordName: string;
+    connectionKey: string;
+}
+/**
+ * Creates a new test context that can be used to test a CRUD records controller.
+ * @param storeFactory The factory function that creates the store.
+ * @param controllerFactory The factory function that creates the controller.
+ */
+export declare function setupTestContext<TKey, TItem extends SubCrudRecord<TKey>, TStore extends SubCrudRecordsStore<TKey, TItem>, TRecordStore extends CrudRecordsStore<CrudRecord>, TController extends SubCrudRecordsController<TKey, TItem, TStore, TRecordStore>>(recordStoreFactory: (services: TestControllers) => TRecordStore, storeFactory: (services: TestControllers, recordStore: TRecordStore) => TStore, controllerFactory: (config: TestControllerConfiguration<TKey, TItem, TStore, TRecordStore>, services: TestControllers) => TController): Promise<TestContext<TKey, TItem, TStore, TRecordStore, TController>>;
+/**
+ * Runs all of the common tests for a CRUD records controller.
+ * @param allowRecordKeys Whether record keys can be used to access the resources.
+ * @param resourceKind The resource kind that should be expected.
+ * @param storeFactory The factory function that creates the store.
+ * @param controllerFactory The factory function that creates the controller.
+ * @param createTestItem The factory function that creates a test item.
+ * @param configureEnvironment An optional function that can be used to configure the environment before the tests are run.
+ */
+export declare function testCrudRecordsController<TKey, TItem extends SubCrudRecord<TKey>, TStore extends SubCrudRecordsStore<TKey, TItem>, TRecordStore extends CrudRecordsStore<CrudRecord>, TController extends SubCrudRecordsController<TKey, TItem, TStore, TRecordStore>>(allowRecordKeys: boolean, resourceKind: ResourceKinds, recordStoreFactory: (services: TestControllers) => TRecordStore, storeFactory: (services: TestControllers, recordStore: TRecordStore) => TStore, controllerFactory: (config: TestControllerConfiguration<TKey, TItem, TStore, TRecordStore>, services: TestControllers) => TController, createKey: (id: number) => TKey, createTestItem: (item: SubCrudRecord<TKey>) => TItem, createRecordItem: (item: CrudRecord) => CrudRecord, configureEnvironment?: (context: TestContext<TKey, TItem, TStore, TRecordStore, TController>) => Promise<void>, allowedActions?: ActionKinds[]): void;
+//# sourceMappingURL=SubCrudRecordsControllerTests.d.ts.map