@nu-art/file-upload-shared 0.401.9 → 0.500.0

package/assets/apis.d.ts

@@ -1,8 +1,8 @@
-import { ApiDef, ApiDefResolver, BodyApi, HttpMethod, QueryApi } from '@nu-art/thunderstorm-shared';
-import { DB_Asset } from './types1.js';
+import { ApiDef, ApiDefResolver, BodyApi, HttpMethod, QueryApi } from '@nu-art/api-types';
+import { DB_Asset } from './types.js';
 import { DB_BaseObject } from '@nu-art/ts-common';
 import { UI_Asset } from './types.js';
-import { ResponseError } from '@nu-art/ts-common/core/exceptions/types';
+import type { ResponseError } from '@nu-art/api-types';
 import { FileStatus } from '../types.js';
 export type SignedUrl = {
     signedUrl: string;
@@ -10,24 +10,20 @@ export type SignedUrl = {
 export type TempSignedUrl = SignedUrl & {
     asset: DB_Asset;
 };
-export type ApiStruct_Assets = {
-    vv1: {
-        getReadSignedUrl: BodyApi<SignedUrl, DB_BaseObject>;
-    };
+export type API_Assets = {
+    getReadSignedUrl: BodyApi<SignedUrl, DB_BaseObject>;
 };
-export declare const ApiDef_Assets: ApiDefResolver<ApiStruct_Assets>;
+export declare const ApiDef_Assets: ApiDefResolver<API_Assets>;
 export type FileUploadResult = {
     status: FileStatus;
     asset: DB_Asset;
 };
-export type Api_UploadFile = BodyApi<FileUploadResult, any, any, ResponseError, HttpMethod.PUT>;
+export type Api_UploadFile = BodyApi<FileUploadResult, any, ResponseError, HttpMethod.PUT>;
 export declare const ApiDef_UploadFile: ApiDef<Api_UploadFile>;
-export type ApiStruct_AssetUploader = {
-    vv1: {
-        getUploadUrl: BodyApi<TempSignedUrl[], UI_Asset[]>;
-        processAssetManually: QueryApi<void[], {
-            feId?: string;
-        }>;
-    };
+export type API_AssetUploader = {
+    getUploadUrl: BodyApi<TempSignedUrl[], UI_Asset[]>;
+    processAssetManually: QueryApi<void[], {
+        feId?: string;
+    }>;
 };
-export declare const ApiDef_AssetUploader: ApiDefResolver<ApiStruct_AssetUploader>;
+export declare const ApiDef_AssetUploader: ApiDefResolver<API_AssetUploader>;

package/assets/apis.js

@@ -1,13 +1,9 @@
-import { HttpMethod } from '@nu-art/thunderstorm-shared';
+import { HttpMethod } from '@nu-art/api-types';
 export const ApiDef_Assets = {
-    vv1: {
-        getReadSignedUrl: { method: HttpMethod.POST, path: 'v1/assets/get-read-signed-url' },
-    }
+    getReadSignedUrl: { method: HttpMethod.POST, path: 'v1/assets/get-read-signed-url' },
 };
 export const ApiDef_UploadFile = { method: HttpMethod.PUT, path: '' };
 export const ApiDef_AssetUploader = {
-    vv1: {
-        getUploadUrl: { method: HttpMethod.POST, path: 'v1/upload/get-url' },
-        processAssetManually: { method: HttpMethod.GET, path: 'v1/upload/process-asset-manually' },
-    }
+    getUploadUrl: { method: HttpMethod.POST, path: 'v1/upload/get-url' },
+    processAssetManually: { method: HttpMethod.GET, path: 'v1/upload/process-asset-manually' },
 };

package/assets/db-def.d.ts

@@ -1,5 +1,5 @@
-import { DBDef_V3 } from '@nu-art/ts-common';
-import { DBProto_Assets, DBProto_AssetsDeleted, DBProto_AssetsTemp } from './types.js';
-export declare const DBDef_Assets: DBDef_V3<DBProto_Assets>;
-export declare const DBDef_TempAssets: DBDef_V3<DBProto_AssetsTemp>;
-export declare const DBDef_TempDeleted: DBDef_V3<DBProto_AssetsDeleted>;
+import { Database } from '@nu-art/db-api-shared';
+import { DatabaseDef_Assets, DatabaseDef_AssetsDeleted, DatabaseDef_AssetsTemp } from './types.js';
+export declare const DBDef_Assets: Database<DatabaseDef_Assets>;
+export declare const DBDef_TempAssets: Database<DatabaseDef_AssetsTemp>;
+export declare const DBDef_TempDeleted: Database<DatabaseDef_AssetsDeleted>;

package/assets/db-def.js

@@ -19,41 +19,33 @@ const Validator_GeneratedProps = {
         validUntil: tsValidateNumber()
     })
 };
-export const DBDef_Assets = {
+const AssetVersions = ['1.0.2', '1.0.1', '1.0.0'];
+const GeneratedProps = ['signedUrl', 'timestamp', 'md5Hash', 'path', 'bucketName', 'public', 'metadata'];
+const BaseDef = {
     modifiablePropsValidator: Validator_ModifiableProps,
     generatedPropsValidator: Validator_GeneratedProps,
-    versions: ['1.0.2', '1.0.1', '1.0.0'],
+    generatedProps: GeneratedProps,
+    versions: AssetVersions,
+    frontend: { group: AssetDBGroup, name: 'asset' },
+    backend: { name: 'assets' },
+};
+export const DBDef_Assets = {
+    ...BaseDef,
     dbKey: 'assets',
     entityName: convertUpperCamelCase('Assets', '-').toLowerCase(),
-    frontend: {
-        group: AssetDBGroup,
-        name: 'asset'
-    },
-    backend: {
-        name: 'assets',
-    }
+    backend: { name: 'assets' },
 };
 export const DBDef_TempAssets = {
-    ...DBDef_Assets,
+    ...BaseDef,
     dbKey: 'assets-temp',
     entityName: 'assets-temp',
-    frontend: {
-        group: AssetDBGroup,
-        name: 'temp'
-    },
-    backend: {
-        name: 'assets-temp',
-    }
+    frontend: { group: AssetDBGroup, name: 'temp' },
+    backend: { name: 'assets-temp' },
 };
 export const DBDef_TempDeleted = {
-    ...DBDef_Assets,
+    ...BaseDef,
     dbKey: 'assets-deleted',
     entityName: 'assets-deleted',
-    frontend: {
-        group: AssetDBGroup,
-        name: 'deleted'
-    },
-    backend: {
-        name: 'assets-deleted',
-    }
+    frontend: { group: AssetDBGroup, name: 'deleted' },
+    backend: { name: 'assets-deleted' },
 };

package/assets/index.d.ts

@@ -1,3 +1,4 @@
 export * from './types.js';
 export * from './db-def.js';
 export * from './apis.js';
+export type { PushMessage_FileUploaded } from './messages.js';

package/assets/messages.d.ts

@@ -1,5 +1,5 @@
 import { PushMessage } from '@nu-art/push-pub-sub-shared';
-import { DB_Asset } from './types1.js';
+import { DB_Asset } from './types.js';
 export declare const PushKey_FileUploaded = "file-uploaded";
 export declare enum FileStatus {
     Idle = "Idle",

package/assets/types.d.ts

@@ -1,5 +1,9 @@
-import { DB_Object, DBProto, Proto_DB_Object, TS_Object, VersionsDeclaration } from '@nu-art/ts-common';
+import { DB_Object, DB_ProtoSeed, DB_Prototype, VersionsDeclaration } from '@nu-art/db-api-shared';
+import { TS_Object } from '@nu-art/ts-common';
 export declare const AssetDBGroup = "asset";
+declare const Assets_DbKey = "assets";
+declare const AssetsTemp_DbKey = "assets-temp";
+declare const AssetsDeleted_DbKey = "assets-deleted";
 type VersionTypes_Asset = {
     '1.0.0': DB_Asset;
     '1.0.1': DB_Asset;
@@ -9,14 +13,8 @@ type Versions = VersionsDeclaration<['1.0.2', '1.0.1', '1.0.0'], VersionTypes_As
 type Dependencies = {};
 type UniqueKeys = '_id';
 type GeneratedKeys = 'signedUrl' | 'timestamp' | 'md5Hash' | 'path' | 'bucketName' | 'public' | 'metadata';
-type ProtoAssets = Proto_DB_Object<DB_Asset, 'assets', GeneratedKeys, Versions, UniqueKeys, Dependencies>;
-export type DBProto_Assets = DBProto<ProtoAssets>;
-type ProtoAssetsTemp = Proto_DB_Object<DB_Asset, 'assets-temp', GeneratedKeys, Versions, UniqueKeys, Dependencies>;
-export type DBProto_AssetsTemp = DBProto<ProtoAssetsTemp>;
-type ProtoAssetsDeleted = Proto_DB_Object<DB_Asset, 'assets-deleted', GeneratedKeys, Versions, UniqueKeys, Dependencies>;
-export type DBProto_AssetsDeleted = DBProto<ProtoAssetsDeleted>;
-export type UI_Asset = DBProto_Assets['uiType'];
-export type DB_Asset = DB_Object & {
+/** Shared entity fields for assets (all three collections). */
+export type AssetData = {
     key: string;
     name: string;
     feId: string;
@@ -33,4 +31,31 @@ export type DB_Asset = DB_Object & {
         validUntil: number;
     };
 };
+export type DB_Asset = DB_Object<typeof Assets_DbKey> & AssetData;
+export type DB_AssetTemp = DB_Object<typeof AssetsTemp_DbKey> & AssetData;
+export type DB_AssetDeleted = DB_Object<typeof AssetsDeleted_DbKey> & AssetData;
+export type DatabaseDef_Assets = DB_Prototype<DB_ProtoSeed<DB_Asset, typeof Assets_DbKey, GeneratedKeys, Versions, UniqueKeys, Dependencies>>;
+export type DatabaseDef_AssetsTemp = DB_Prototype<DB_ProtoSeed<DB_AssetTemp, typeof AssetsTemp_DbKey, GeneratedKeys, Versions, UniqueKeys, Dependencies>>;
+export type DatabaseDef_AssetsDeleted = DB_Prototype<DB_ProtoSeed<DB_AssetDeleted, typeof AssetsDeleted_DbKey, GeneratedKeys, Versions, UniqueKeys, Dependencies>>;
+export type UI_Asset = DatabaseDef_Assets['uiType'];
+/** Request shape for upload (name, mimeType, key?, public?, metadata?). */
+export type Request_Uploader = {
+    name: string;
+    mimeType: string;
+    key?: string;
+    public?: boolean;
+    metadata?: TS_Object;
+};
+export type BaseUploaderFile = Request_Uploader & {
+    feId: string;
+};
+/** Minimal progress event for upload requests. */
+export type UploadProgressEvent = {
+    loaded: number;
+    total?: number;
+};
+/** Minimal request handle for upload progress. */
+export type ProgressableRequest = {
+    setOnProgressListener?(cb: (ev: UploadProgressEvent) => void): void;
+};
 export {};

package/assets/types.js

@@ -1 +1,4 @@
 export const AssetDBGroup = 'asset';
+const Assets_DbKey = 'assets';
+const AssetsTemp_DbKey = 'assets-temp';
+const AssetsDeleted_DbKey = 'assets-deleted';

package/index.d.ts

@@ -1,2 +1,3 @@
 export * from './assets/index.js';
 export * from './types.js';
+export * from './modules/ModuleBase_AssetUploader.js';

package/index.js

@@ -1,2 +1,3 @@
 export * from './assets/index.js';
 export * from './types.js';
+export * from './modules/ModuleBase_AssetUploader.js';

package/modules/ModuleBase_AssetUploader.d.ts

@@ -1,11 +1,23 @@
 import { Dispatcher, Module } from '@nu-art/ts-common';
-import { ApiDef, ApiDefCaller, BaseHttpRequest, TypedApi } from '@nu-art/thunderstorm-shared';
+import { ApiDef, TypedApi } from '@nu-art/api-types';
+import type { ApiDefCaller } from '@nu-art/api-types';
 import { OnPushMessageReceived } from '@nu-art/push-pub-sub-shared';
 import { PushMessage_Payload } from '@nu-art/push-pub-sub-shared';
 import { FileStatus, PushMessage_FileUploaded } from '../assets/messages.js';
 import { DB_Asset, UI_Asset } from '../assets/types.js';
-import { ApiStruct_AssetUploader, TempSignedUrl } from '../assets/apis.js';
+import { API_AssetUploader, TempSignedUrl } from '../assets/apis.js';
+import type { ProgressableRequest, UploadProgressEvent } from '../assets/types.js';
 import { OnFileStatusChanged } from '../types.js';
+/** Request handle for upload: used by createRequest and FileInfo.request. Replaces BaseHttpRequest in shared. */
+export interface IAssetUploadRequest<API> {
+    setUrl(url: string): this;
+    setHeader(key: string, value: string): this;
+    setTimeout(ms: number): this;
+    setBody(body: unknown): this;
+    setOnProgressListener(cb: (ev: UploadProgressEvent) => void): this;
+    executeSync(): Promise<unknown>;
+    execute(cb: (response: unknown) => void): void;
+}
 export type FilesToUpload = UI_Asset & {
     file: any;
 };
@@ -14,7 +26,7 @@ export type FileInfo = {
     messageStatus?: string;
     progress?: number;
     name: string;
-    request?: BaseHttpRequest<any>;
+    request?: ProgressableRequest;
     file?: any;
     asset?: DB_Asset;
 };
@@ -23,7 +35,7 @@ export type UploaderConfig = {
     uploadQueueParallelCount?: number;
 };
 export declare abstract class ModuleBase_AssetUploader<Config extends UploaderConfig = UploaderConfig> extends Module<Config> implements OnPushMessageReceived<PushMessage_FileUploaded> {
-    protected vv1: ApiDefCaller<ApiStruct_AssetUploader>['vv1'];
+    protected vv1: ApiDefCaller<API_AssetUploader>;
     protected files: {
         [id: string]: FileInfo;
     };
@@ -41,5 +53,5 @@ export declare abstract class ModuleBase_AssetUploader<Config extends UploaderCo
     private uploadFiles;
     private uploadFile;
     processAssetManually: (feId?: string) => void;
-    protected abstract createRequest<API extends TypedApi<any, any, any, any>>(uploadFile: ApiDef<API>): BaseHttpRequest<API>;
+    protected abstract createRequest<API extends TypedApi<any, any, any, any>>(uploadFile: ApiDef<API>): IAssetUploadRequest<API>;
 }

package/modules/ModuleBase_AssetUploader.js

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 import { __stringify, _keys, BadImplementationException, Dispatcher, Minute, Module, Queue } from '@nu-art/ts-common';
-import { HeaderKey_ContentType } from '@nu-art/thunderstorm-shared';
+import { HeaderKey_ContentType } from '@nu-art/api-types';
 import { FileStatus, PushKey_FileUploaded } from '../assets/messages.js';
 import { ApiDef_UploadFile } from '../assets/apis.js';
 export class ModuleBase_AssetUploader extends Module {
@@ -73,12 +73,11 @@ export class ModuleBase_AssetUploader extends Module {
             return fileInfo;
         });
         this.vv1.getUploadUrl?.(body)
-            .execute(async (response) => {
+            ?.execute((response) => {
             body.forEach(f => this.setFileInfo(f.feId, { status: FileStatus.UrlObtained }));
             if (!response)
                 return;
-            // Not a relevant await but still...
-            await this.uploadFiles(response);
+            void this.uploadFiles(response);
         });
         return body;
     }
@@ -119,7 +118,7 @@ export class ModuleBase_AssetUploader extends Module {
             .setTimeout(20 * Minute)
             .setBody(fileInfo.file)
             .setOnProgressListener((ev) => {
-            this.setFileInfo(feId, { progress: ev.loaded / ev.total });
+            this.setFileInfo(feId, { progress: ev.total ? ev.loaded / ev.total : 0 });
         });
         fileInfo.request = request;
         await request.executeSync();
@@ -131,10 +130,6 @@ export class ModuleBase_AssetUploader extends Module {
     };
     processAssetManually = (feId) => {
         const request = this.vv1.processAssetManually({ feId });
-        // const request = this
-        // 	.httpModule
-        // 	.createRequest<Api_ProcessAssetManually>(HttpMethod.GET, RequestKey_ProcessAssetManually, feId)
-        // 	.setRelativeUrl('v1/upload/process-asset-manually');
         if (feId)
             request.setUrlParam('feId', feId);
         request.execute();

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@nu-art/file-upload-shared",
-  "version": "0.401.9",
+  "version": "0.500.0",
   "description": "File Uploader - Express & Typescript based backend framework Shared",
   "keywords": [
     "TacB0sS",
     "infra",
     "nu-art",
     "storm",
-    "thunderstorm",
     "typescript"
   ],
   "homepage": "https://github.com/nu-art-js/file-upload",
@@ -31,13 +30,14 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@nu-art/firebase-shared": "0.401.9",
-    "@nu-art/ts-styles": "0.401.9",
-    "@nu-art/push-pub-sub-shared": "0.401.9",
-    "@nu-art/permissions-shared": "0.401.9",
-    "@nu-art/user-account-shared": "0.401.9",
-    "@nu-art/thunderstorm-shared": "0.401.9",
-    "@nu-art/ts-common": "0.401.9",
+    "@nu-art/firebase-shared": "0.500.0",
+    "@nu-art/ts-styles": "0.500.0",
+    "@nu-art/push-pub-sub-shared": "0.500.0",
+    "@nu-art/permissions-shared": "0.500.0",
+    "@nu-art/user-account-shared": "0.500.0",
+    "@nu-art/api-types": "{{THUNDERSTORM_VERSION}}",
+    "@nu-art/db-api-shared": "0.500.0",
+    "@nu-art/ts-common": "0.500.0",
     "@google-cloud/common": "^5.0.2",
     "@google-cloud/storage": "^7.15.0",
     "@google-cloud/firestore": "^7.11.0",

package/assets/types1.d.ts

@@ -1,33 +0,0 @@
-import { BaseHttpRequest } from '@nu-art/thunderstorm-shared';
-import { Auditable, DB_Object, TS_Object } from '@nu-art/ts-common';
-import { FileStatus } from '../types.js';
-export type Request_Uploader = {
-    name: string;
-    mimeType: string;
-    key?: string;
-    public?: boolean;
-    metadata?: TS_Object;
-};
-export type BaseUploaderFile = Request_Uploader & {
-    feId: string;
-};
-export type DB_Asset = DB_Object & BaseUploaderFile & Auditable & Required<Pick<BaseUploaderFile, 'key'>> & {
-    timestamp: number;
-    ext: string;
-    md5Hash?: string;
-    path: string;
-    bucketName: string;
-    signedUrl?: {
-        url: string;
-        validUntil: number;
-    };
-};
-export type FileInfo = {
-    status: FileStatus;
-    messageStatus?: string;
-    progress?: number;
-    name: string;
-    request?: BaseHttpRequest<any>;
-    file?: any;
-    asset?: DB_Asset;
-};

package/assets/types1.js

@@ -1,19 +0,0 @@
-/*
- * Permissions management system, define access level for each of
- * your server apis, and restrict users by giving them access levels
- *
- * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export {};