@appweaver/data 0.0.0-stage → 2.0.1

package/types/auth.d.ts

@@ -0,0 +1,23 @@
+import { AuthSource, AuthUser } from '@appweaver/common';
+import { FileBuffer } from './storage';
+export type AvatarFile = FileBuffer & {
+    size: number;
+};
+export type UserInfo = {
+    id: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    avatarUrl?: string;
+    avatarFile?: AvatarFile;
+};
+export type UserAdditionalData = {
+    firstName: string;
+    lastName: string;
+    avatarUrl?: string;
+    avatarFile?: AvatarFile;
+};
+export type RegistrationDataFn<T = any> = (source: AuthSource, email: string, password?: string, additionalData?: Partial<UserAdditionalData>) => T | Promise<T>;
+export type RegistrationFilesFn = (source: AuthSource, additionalData?: Partial<UserAdditionalData>) => RegistrationFiles | Promise<RegistrationFiles>;
+export type RegistrationFiles = Record<string, FileBuffer | null | undefined>;
+export type CheckOAuth2UserFn = (source: AuthSource, userInfo: UserInfo, authUser: AuthUser | null) => void | string | Error | Promise<void | string | Error>;

package/types/auth.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/types/generated.d.ts

@@ -0,0 +1,366 @@
+import { AggregateSelect, IResourceService, QueryFilter, QuerySort } from '@appweaver/common';
+export type ApiKey = {
+    id: number;
+    key: string;
+    keyHash: string;
+    name?: string | null;
+    description?: string | null;
+    enabled: boolean;
+    expiresAt?: Date | null;
+    updatedAt: Date;
+    createdAt: Date;
+    createdById?: number | null;
+};
+export type ApiKeySingle = {
+    id: number;
+    key: string;
+    name?: string | null;
+    description?: string | null;
+    enabled: boolean;
+    expiresAt?: Date | null;
+    updatedAt: Date;
+    createdAt: Date;
+    createdById?: number | null;
+};
+export type ApiKeyMultiple = {
+    id: number;
+    key: string;
+    name?: string | null;
+    description?: string | null;
+    enabled: boolean;
+    expiresAt?: Date | null;
+    updatedAt: Date;
+    createdAt: Date;
+    createdById?: number | null;
+};
+export type ApiKeyCreate = {
+    name?: string | null;
+    description?: string | null;
+    enabled?: boolean;
+    expiresAt?: Date | null;
+};
+export type ApiKeyUpdate = {
+    name?: string | null;
+    description?: string | null;
+    enabled?: boolean;
+};
+export type ApiKeyReplace = {
+    name?: string | null;
+    description?: string | null;
+    enabled?: boolean;
+};
+export type ApiKeyRelationCreate = {
+    name?: string | null;
+    description?: string | null;
+    enabled?: boolean;
+    expiresAt?: Date | null;
+};
+export type ApiKeyRelationUpdate = {
+    id: number;
+    name?: string | null;
+    description?: string | null;
+    enabled?: boolean;
+};
+export type ApiKeyQuery = QueryFilter<ApiKey>;
+export type ApiKeySort = QuerySort<ApiKeyMultiple>;
+export type ApiKeyAggregate = AggregateSelect<ApiKey>;
+export type ApiKeyResourceService = IResourceService<ApiKey, ApiKeyMultiple, ApiKeyCreate, ApiKeyUpdate, ApiKeyQuery, ApiKeyReplace>;
+export type ConnectedAccount = {
+    id: number;
+    provider: string;
+    providerAccountId: string;
+    scope?: string | null;
+    lastLoginAt: Date;
+    updatedAt: Date;
+    createdAt: Date;
+};
+export type ConnectedAccountSingle = {
+    id: number;
+    provider: string;
+    providerAccountId: string;
+    scope?: string | null;
+    lastLoginAt: Date;
+    updatedAt: Date;
+    createdAt: Date;
+};
+export type ConnectedAccountMultiple = {
+    id: number;
+    provider: string;
+    providerAccountId: string;
+    scope?: string | null;
+    lastLoginAt: Date;
+    updatedAt: Date;
+    createdAt: Date;
+};
+export type ConnectedAccountCreate = {
+    provider: string;
+    providerAccountId: string;
+    scope?: string | null;
+    lastLoginAt: Date;
+};
+export type ConnectedAccountUpdate = {
+    provider?: string;
+    providerAccountId?: string;
+    scope?: string | null;
+    lastLoginAt?: Date;
+};
+export type ConnectedAccountReplace = {
+    provider: string;
+    providerAccountId: string;
+    scope?: string | null;
+    lastLoginAt: Date;
+};
+export type ConnectedAccountRelationCreate = {
+    provider: string;
+    providerAccountId: string;
+    scope?: string | null;
+    lastLoginAt: Date;
+};
+export type ConnectedAccountRelationUpdate = {
+    id: number;
+    provider?: string;
+    providerAccountId?: string;
+    scope?: string | null;
+    lastLoginAt?: Date;
+};
+export type ConnectedAccountQuery = QueryFilter<ConnectedAccount>;
+export type ConnectedAccountSort = QuerySort<ConnectedAccountMultiple>;
+export type ConnectedAccountAggregate = AggregateSelect<ConnectedAccount>;
+export type ConnectedAccountResourceService = IResourceService<ConnectedAccount, ConnectedAccountMultiple, ConnectedAccountCreate, ConnectedAccountUpdate, ConnectedAccountQuery, ConnectedAccountReplace>;
+export type OneTimeToken = {
+    id: number;
+    tokenHash: string;
+    purpose: string;
+    data: any;
+    expiresAt: Date;
+    createdAt: Date;
+};
+export type OneTimeTokenSingle = {
+    id: number;
+    tokenHash: string;
+    purpose: string;
+    data: any;
+    expiresAt: Date;
+    createdAt: Date;
+};
+export type OneTimeTokenMultiple = {
+    id: number;
+    tokenHash: string;
+    purpose: string;
+    data: any;
+    expiresAt: Date;
+    createdAt: Date;
+};
+export type OneTimeTokenCreate = {
+    tokenHash: string;
+    purpose: string;
+    data: any;
+    expiresAt: Date;
+};
+export type OneTimeTokenUpdate = {
+    tokenHash?: string;
+    purpose?: string;
+    data?: any;
+    expiresAt?: Date;
+};
+export type OneTimeTokenReplace = {
+    tokenHash: string;
+    purpose: string;
+    data: any;
+    expiresAt: Date;
+};
+export type OneTimeTokenRelationCreate = {
+    tokenHash: string;
+    purpose: string;
+    data: any;
+    expiresAt: Date;
+};
+export type OneTimeTokenRelationUpdate = {
+    id: number;
+    tokenHash?: string;
+    purpose?: string;
+    data?: any;
+    expiresAt?: Date;
+};
+export type OneTimeTokenQuery = QueryFilter<OneTimeToken>;
+export type OneTimeTokenSort = QuerySort<OneTimeTokenMultiple>;
+export type OneTimeTokenAggregate = AggregateSelect<OneTimeToken>;
+export type OneTimeTokenResourceService = IResourceService<OneTimeToken, OneTimeTokenMultiple, OneTimeTokenCreate, OneTimeTokenUpdate, OneTimeTokenQuery, OneTimeTokenReplace>;
+export type Permission = {
+    id: number;
+    name: string;
+    updatedAt: Date;
+    createdAt: Date;
+    createdById?: number | null;
+};
+export type PermissionSingle = {
+    id: number;
+    name: string;
+};
+export type PermissionMultiple = {
+    id: number;
+    name: string;
+};
+export type PermissionCreate = {
+    name: string;
+};
+export type PermissionUpdate = {
+    name?: string;
+};
+export type PermissionReplace = {
+    name: string;
+};
+export type PermissionRelationCreate = {
+    name: string;
+};
+export type PermissionRelationUpdate = {
+    id: number;
+    name?: string;
+};
+export type PermissionQuery = QueryFilter<Permission>;
+export type PermissionSort = QuerySort<PermissionMultiple>;
+export type PermissionAggregate = AggregateSelect<Permission>;
+export type PermissionResourceService = IResourceService<Permission, PermissionMultiple, PermissionCreate, PermissionUpdate, PermissionQuery, PermissionReplace>;
+export type Role = {
+    id: number;
+    name: string;
+    permissions: Array<PermissionSingle>;
+    updatedAt: Date;
+    createdAt: Date;
+    createdById?: number | null;
+};
+export type RoleSingle = {
+    id: number;
+    name: string;
+    permissions?: Array<PermissionSingle>;
+};
+export type RoleMultiple = {
+    id: number;
+    name: string;
+    permissions?: Array<PermissionSingle>;
+};
+export type RoleCreate = {
+    name: string;
+    permissions: Array<{
+        id: number;
+    } | number>;
+};
+export type RoleUpdate = {
+    name?: string;
+    permissions?: Array<{
+        id: number;
+    } | number>;
+};
+export type RoleReplace = {
+    name: string;
+    permissions: Array<{
+        id: number;
+    } | number>;
+};
+export type RoleRelationCreate = {
+    name: string;
+};
+export type RoleRelationUpdate = {
+    id: number;
+    name?: string;
+};
+export type RoleQuery = QueryFilter<Role>;
+export type RoleSort = QuerySort<RoleMultiple>;
+export type RoleAggregate = AggregateSelect<Role>;
+export type RoleResourceService = IResourceService<Role, RoleMultiple, RoleCreate, RoleUpdate, RoleQuery, RoleReplace>;
+export type File = {
+    id: number;
+    name: string;
+    originalName: string;
+    mimeType: string;
+    sizeBytes: number;
+    checksum: string;
+    title?: string | null;
+    description?: string | null;
+    resourceField?: string | null;
+    resourceName?: string | null;
+    resourceId?: string | null;
+    url: string;
+    updatedAt: Date;
+    createdAt: Date;
+    createdById?: number | null;
+    deletedAt?: Date | null;
+};
+export type FileSingle = {
+    id: number;
+    name: string;
+    originalName: string;
+    mimeType: string;
+    sizeBytes: number;
+    checksum: string;
+    title?: string | null;
+    description?: string | null;
+    url: string;
+    updatedAt: Date;
+    createdAt: Date;
+    createdById?: number | null;
+};
+export type FileMultiple = {
+    id: number;
+    name: string;
+    originalName: string;
+    mimeType: string;
+    sizeBytes: number;
+    checksum: string;
+    title?: string | null;
+    description?: string | null;
+    url: string;
+    updatedAt: Date;
+    createdAt: Date;
+    createdById?: number | null;
+};
+export type FileCreate = {
+    name: string;
+    originalName: string;
+    mimeType: string;
+    sizeBytes: number;
+    checksum: string;
+    title?: string | null;
+    description?: string | null;
+};
+export type FileUpdate = {
+    name?: string;
+    originalName?: string;
+    mimeType?: string;
+    sizeBytes?: number;
+    checksum?: string;
+    title?: string | null;
+    description?: string | null;
+};
+export type FileReplace = {
+    name: string;
+    originalName: string;
+    mimeType: string;
+    sizeBytes: number;
+    checksum: string;
+    title?: string | null;
+    description?: string | null;
+};
+export type FileRelationCreate = {
+    name: string;
+    originalName: string;
+    mimeType: string;
+    sizeBytes: number;
+    checksum: string;
+    title?: string | null;
+    description?: string | null;
+};
+export type FileRelationUpdate = {
+    id: number;
+    name?: string;
+    originalName?: string;
+    mimeType?: string;
+    sizeBytes?: number;
+    checksum?: string;
+    title?: string | null;
+    description?: string | null;
+};
+export type FileQuery = QueryFilter<File>;
+export type FileSort = QuerySort<FileMultiple>;
+export type FileAggregate = AggregateSelect<File>;
+export type FileResourceService = IResourceService<File, FileMultiple, FileCreate, FileUpdate, FileQuery, FileReplace>;

package/types/generated.js

@@ -0,0 +1,3 @@
+"use strict";
+// Generated by Appweaver. Please do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/types/storage.d.ts

@@ -0,0 +1,35 @@
+import { Readable } from 'node:stream';
+/**
+ * An in-memory file, used to store a file that was not received as a multipart upload, such as an avatar downloaded
+ * from an OAuth2 provider or an image generated by the application itself.
+ */
+export type FileBuffer = {
+    /** The original file name, used to derive the stored name and its extension. */
+    name: string;
+    /** The media type of the content, checked against the `mimeType` of the file field. */
+    mimeType: string;
+    /** The file content. */
+    data: Buffer;
+    /** The content size in bytes checked against the size limit of the file field, defaults to the data buffer length. */
+    size?: number;
+    /** The content encoding, defaults to `7bit`. */
+    encoding?: string;
+};
+/** A file part of a multipart upload, the shape of the files of `@fastify/multipart`. */
+export type UploadedFile = {
+    type: 'file';
+    fieldname: string;
+    filename: string;
+    encoding: string;
+    mimetype: string;
+    /** The content, with the bytes read so far and whether the size limit truncated it. */
+    file: Readable & {
+        bytesRead: number;
+        truncated: boolean;
+    };
+};
+/** A part of a multipart upload: a file, or a field the file services skip. */
+export type UploadPart = UploadedFile | {
+    type: 'field';
+    fieldname: string;
+};

package/types/storage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/utils/export-util.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts an array of data into a CSV-formatted string.
+ *
+ * @param {Object[]} data - The array of data to be converted into CSV format.
+ * @param {boolean} [header=false] - Whether to include a header row in the generated CSV.
+ * @return {string} The CSV-formatted string representation of the input data.
+ */
+export declare function toCsv(data: any[], header?: boolean): string;

package/utils/export-util.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCsv = toCsv;
+const sync_1 = require("csv-stringify/sync");
+const common_1 = require("@appweaver/common");
+const export_config_1 = require("../export/export-config");
+/**
+ * Converts an array of data into a CSV-formatted string.
+ *
+ * @param {Object[]} data - The array of data to be converted into CSV format.
+ * @param {boolean} [header=false] - Whether to include a header row in the generated CSV.
+ * @return {string} The CSV-formatted string representation of the input data.
+ */
+function toCsv(data, header = false) {
+    return (0, sync_1.stringify)(Object.values(data), {
+        delimiter: export_config_1.exportConfig.CSV_DELIMITER,
+        cast: {
+            date: (value) => value.toISOString(),
+            object: (value) => (0, common_1.isArray)(value) &&
+                ((0, common_1.isString)(value) || (0, common_1.isNumber)(value) || (0, common_1.isBoolean)(value))
+                ? value.join(export_config_1.exportConfig.CSV_JOIN_DELIMITER)
+                : JSON.stringify(value)
+        },
+        header
+    });
+}

package/utils/file-util.d.ts

@@ -0,0 +1,106 @@
+import { FilesConfig, ResourceModel } from '@appweaver/common';
+import { File } from '../types/generated';
+/**
+ * Builds the access URL for a stored file. The `public` or `protected` path prefix is resolved from the access type
+ * configured in the file policy of the resource owning the file, and the route prefix is taken from the
+ * `STORAGE_FILES_ROUTE_PREFIX` configuration.
+ *
+ * @param {File} file - The file object containing the name and owning resource information.
+ * @return {string} The absolute URL for accessing the file.
+ */
+export declare function buildFileUrl(file: File): string;
+/**
+ * Splits the file fields of a deleted resource by what happens to their files. On a delete removing the resource from
+ * the database each field follows its `onResourceDeleted` option, which defaults to `'delete'`, while on a soft delete
+ * it follows its `onResourceSoftDeleted` option, which defaults to `'keep'`.
+ *
+ * @param {FilesConfig} [files] - The file fields of the deleted resource's model.
+ * @param {boolean} softDeleted - Whether the resource was soft deleted.
+ * @return {{deleted: string[], kept: string[]}} The fields whose files are removed from storage, and the fields whose
+ * files are retained, but no longer served.
+ */
+export declare function deletedResourceFileFields(files: FilesConfig | undefined, softDeleted: boolean): {
+    deleted: string[];
+    kept: string[];
+};
+/**
+ * Parses a range string and converts it into an object with start and end values.
+ *
+ * @param {string} [range] - The range string to parse, typically in the format "bytes=start-end".
+ * @return {{start: number, end?: number}} An object containing the start value and an optional end value.
+ */
+export declare function parseRange(range?: string): {
+    start: number;
+    end?: number;
+};
+/**
+ * Calculates the maximum file size allowed based on the provided file configuration.
+ *
+ * @param {FilesConfig} fileConfig - An object containing file configuration data, including maximum size for each file
+ * type.
+ * @return {number} The maximum size in bytes allowed for any file based on the given configuration.
+ */
+export declare function maxFileSize(fileConfig: FilesConfig): number;
+/**
+ * Converts a given size represented as a string or number into its equivalent size in bytes.
+ *
+ * @param {string | number} [size] - The size to be converted, either as a string or a number.
+ * @return {number} The size in bytes. Returns 0 if the input is invalid or not provided.
+ */
+export declare function sizeInBytes(size?: string | number): number;
+/**
+ * Validates if the provided MIME type matches a given pattern or regular expression.
+ *
+ * @param {string} mimeType - The MIME type to validate.
+ * @param {string|RegExp} [mimeTypeExp] - An optional pattern or regular expression to match the MIME type against.
+ *                                       If not provided, the method will always return true.
+ * @return {boolean} True if the MIME type matches the specified pattern or regular expression, false otherwise.
+ */
+export declare function isValidMimeType(mimeType: string, mimeTypeExp?: string | RegExp): boolean;
+/**
+ * Generates a file name based on a given name, an optional pattern, and a set of variables.
+ *
+ * @param {string} name The original file name including its extension.
+ * @param {string} [pattern] An optional pattern to customize the generated file name. If not provided, a default
+ * pattern will be used.
+ * @param {Record<string, any>} [variables={}] Additional variables to replace in the pattern. These can include custom
+ * placeholders to dynamically generate the file name.
+ * @return {string} The generated, sanitized file name based on the provided or default pattern.
+ */
+export declare function generateFileName(name: string, pattern?: string, variables?: Record<string, any>): string;
+/**
+ * Validates that no configured file name pattern writes into a path reserved by `STORAGE_RESERVED_PATHS`. Both the
+ * global `STORAGE_NAME_PATTERN` and the `namePattern` of every file field of the provided models are checked. Patterns
+ * defined as a factory function cannot be resolved before an upload, so they are validated at runtime instead.
+ *
+ * @param {Record<string, ResourceModel>} models - The loaded resource models, keyed by model name.
+ * @throws {Error} Throws an error naming the model, the field, and the reserved path when a pattern is reserved.
+ */
+export declare function validateFileNamePatterns(models: Record<string, ResourceModel>): void;
+/**
+ * Sanitizes a given filename by removing invalid characters that are not allowed in file systems. Path separators are
+ * preserved, since a file name may be a path relative to the storage root.
+ *
+ * @param fileName The original filename to sanitize.
+ * @return A sanitized filename with invalid characters removed.
+ */
+export declare function sanitizeFilename(fileName: string): string;
+/**
+ * Sanitizes an untrusted value into a single file path segment. In addition to the characters removed by
+ * {@link sanitizeFilename}, all path separators are stripped and leading dots are removed, so that the value can never
+ * introduce a subdirectory, a `..` traversal or a hidden file.
+ *
+ * @param value The untrusted value to sanitize.
+ * @return A sanitized single path segment, or an empty string when nothing usable remains.
+ */
+export declare function sanitizeFileSegment(value?: string | null): string;
+/**
+ * Aggregates the provided files into a structured object based on the given configuration.
+ *
+ * @param {File[]} files - An array of file objects to be processed and aggregated.
+ * @param {FilesConfig} filesConfig - An object that defines the configuration for each file field, including whether
+ * the field supports multiple files.
+ * @return {Record<string, File | File[] | null>} A record where keys correspond to the configured fields, and values
+ * are either a single file, an array of files, or null if no files match the field.
+ */
+export declare function aggregateFiles(files: File[], filesConfig: FilesConfig): Record<string, File | File[] | null>;