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

package/packages/version/PackageVersionRecordsController.d.ts

@@ -0,0 +1,144 @@
+import type { ActionKinds, Entitlement, KnownErrorCodes, UserRole } from '@casual-simulation/aux-common';
+import type { AuthorizationContext, AuthorizeUserAndInstancesSuccess, AuthorizeUserAndInstancesForResourcesSuccess, PolicyController } from '../../PolicyController';
+import type { CheckSubscriptionMetricsFailure, CheckSubscriptionMetricsSuccess, CrudRecordItemRequest, CrudRecordItemSuccess, CrudRecordItemFailure, CrudEraseItemResult, CrudListItemsResult, CrudGetItemFailure, CrudGetItemSuccess } from '../../crud';
+import type { PackageRecordVersion, PackageRecordVersionKey, PackageRecordVersionKeySpecifier, PackageRecordVersionWithMetadata, PackageVersionRecordsStore, PackageVersionReview, PackageVersionSubscriptionMetrics } from './PackageVersionRecordsStore';
+import type { PackageFeaturesConfiguration, SubscriptionConfiguration } from '../../SubscriptionConfiguration';
+import type { SubCrudEraseItemRequest, SubCrudGetItemRequest, SubCrudListItemsRequest, SubCrudRecordsConfiguration } from '../../crud/sub/SubCrudRecordsController';
+import type { PackageRecordsStore } from '../PackageRecordsStore';
+import type { FileRecordsController, ReadFileResult, RecordFileRequest, RecordFileResult } from '../../FileRecordsController';
+import type { ConfigurationStore } from '../../ConfigurationStore';
+import type { SystemNotificationMessenger } from '../../SystemNotificationMessenger';
+import type { PackageRecordsController } from '../PackageRecordsController';
+/**
+ * Defines the configuration for a webhook records controller.
+ */
+export interface PackageVersionRecordsConfiguration extends Omit<SubCrudRecordsConfiguration<PackageRecordVersionKey, PackageRecordVersion, PackageVersionRecordsStore, PackageRecordsStore>, 'resourceKind' | 'allowRecordKeys' | 'name'> {
+    /**
+     * The controller that should be used for package records.
+     */
+    packages: PackageRecordsController;
+    /**
+     * The controller that should be used for file records.
+     */
+    files: FileRecordsController;
+    /**
+     * The controller that should be used for sending system notifications.
+     */
+    systemNotifications: SystemNotificationMessenger | null;
+}
+/**
+ * Defines a controller that can be used to interact with NotificationRecords.
+ */
+export declare class PackageVersionRecordsController {
+    private _store;
+    private _recordStore;
+    private _policies;
+    private _packages;
+    private _config;
+    private _resourceKind;
+    private _files;
+    private _systemNotifications;
+    private _name;
+    get store(): PackageVersionRecordsStore;
+    get config(): ConfigurationStore;
+    get policies(): PolicyController;
+    get files(): FileRecordsController;
+    constructor(config: PackageVersionRecordsConfiguration);
+    /**
+     * Creates or updates an item in the given record.
+     * @param request The request.
+     */
+    recordItem(request: CrudRecordItemRequest<PackageRecordVersionInput>): Promise<RecordPackageVersionResult>;
+    /**
+     * Gets the item with the given address from the given record.
+     * @param request The request to get the item.
+     */
+    getItem(request: SubCrudGetItemRequest<PackageRecordVersionKeySpecifier>): Promise<GetPackageVersionResult>;
+    /**
+     * Deletes the item with the given address from the given record.
+     * @param request The request.
+     */
+    eraseItem(request: SubCrudEraseItemRequest<PackageRecordVersionKey>): Promise<CrudEraseItemResult>;
+    /**
+     * Lists items in the given record.
+     * @param request The request.
+     */
+    listItems(request: SubCrudListItemsRequest): Promise<CrudListItemsResult<PackageRecordVersion>>;
+    reviewItem(request: ReviewPackageVersionRequest): Promise<ReviewPackageVersionResult>;
+    protected _checkSubscriptionMetrics(action: ActionKinds, context: AuthorizationContext, authorization: AuthorizeUserAndInstancesSuccess | AuthorizeUserAndInstancesForResourcesSuccess, item?: PackageRecordVersionInput): Promise<PackageRecordsSubscriptionMetricsResult>;
+}
+/**
+ * Determines whether the given entitlement requires approval.
+ * @param entitlement The entitlement to test.
+ */
+export declare function entitlementRequiresApproval(entitlement: Entitlement): boolean;
+export type PackageRecordVersionInput = Omit<PackageRecordVersion, 'createdAtMs' | 'sha256' | 'sizeInBytes' | 'auxFileName' | 'auxSha256' | 'createdFile' | 'requiresReview' | 'id' | 'markers'> & {
+    auxFileRequest: Omit<RecordFileRequest, 'markers' | 'instances' | 'userRole'>;
+    /**
+     * The markers that should be used for the item if the package doesn't exist.
+     */
+    markers?: string[];
+};
+export type RecordPackageVersionResult = RecordPackageVersionSuccess | CrudRecordItemFailure;
+export interface RecordPackageVersionSuccess extends CrudRecordItemSuccess {
+    /**
+     * The result of recording the aux file.
+     */
+    auxFileResult: RecordFileResult;
+}
+export type PackageRecordsSubscriptionMetricsResult = PackageRecordsSubscriptionMetricsSuccess | CheckSubscriptionMetricsFailure;
+export interface PackageRecordsSubscriptionMetricsSuccess extends CheckSubscriptionMetricsSuccess {
+    config: SubscriptionConfiguration | null;
+    metrics: PackageVersionSubscriptionMetrics;
+    features: PackageFeaturesConfiguration;
+}
+export type GetPackageVersionResult = GetPackageVersionSuccess | CrudGetItemFailure;
+export interface GetPackageVersionSuccess extends CrudGetItemSuccess<PackageRecordVersionWithMetadata> {
+    /**
+     * The result of reading the aux file.
+     *
+     * If successful, then the user is authorized to read the file.
+     * If unsuccessful, then the user is not authorized to read the file.
+     */
+    auxFile: ReadFileResult;
+}
+export type PackageVersionReviewInput = Omit<PackageVersionReview, 'id' | 'packageVersionId' | 'reviewingUserId' | 'createdAtMs' | 'updatedAtMs'> & {
+    /**
+     * The ID of the review.
+     * If omitted, then a new review will be created.
+     */
+    id?: string;
+};
+export interface ReviewPackageVersionRequest {
+    /**
+     * The ID of the package version that the review is for.
+     */
+    packageVersionId: string;
+    /**
+     * The review that should be stored for the package version.
+     */
+    review: PackageVersionReviewInput;
+    /**
+     * The ID of the user that is currently logged in.
+     */
+    userId: string | null;
+    /**
+     * The role of the user that is currently logged in.
+     * If userId is provided, then this should be null or undefined.
+     */
+    userRole?: UserRole;
+}
+export type ReviewPackageVersionResult = ReviewPackageVersionSuccess | ReviewPackageVersionFailure;
+export interface ReviewPackageVersionSuccess {
+    success: true;
+    /**
+     * The ID of the review that was created or updated.
+     */
+    reviewId: string;
+}
+export interface ReviewPackageVersionFailure {
+    success: false;
+    errorCode: KnownErrorCodes;
+    errorMessage: string;
+}
+//# sourceMappingURL=PackageVersionRecordsController.d.ts.map