Cloud constructor for E-mc.
npm install @e-mc/cloud* NodeJS 18.20.5 LTS
* ES2022
``typescript
import type { IHost, IScopeOrigin } from "./index";
import type { ExternalAsset } from "./asset";
import type { BucketWebsiteOptions, CloudDatabase, CloudFeatures, CloudFunctions, CloudService, CloudStorage, CloudStorageDownload, CloudStorageUpload, DeleteObjectsOptions, UploadAssetOptions } from "./cloud";
import type { ClientDbConstructor, IClientDb } from "./core";
import type { BatchQueryResult, QueryResult } from "./db";
import type { LogMessageOptions } from "./logger";
import type { CloudAuthSettings, CloudModule, CloudServiceOptions, CloudSettings, DbCoerceSettings } from "./settings";
interface ICloud extends IClientDb
module: CloudModule;
readonly uploaded: string[];
readonly downloaded: string[];
createBucket(service: string, credential: unknown, bucket: string, acl?: unknown, options?: unknown): Promise
createBucket(service: string, credential: unknown, bucket: string, publicRead?: boolean): Promise
setBucketPolicy(service: string, credential: unknown, bucket: string, options: unknown): Promise
setBucketTagging(service: string, credential: unknown, bucket: string, options: unknown): Promise
setBucketWebsite(service: string, credential: unknown, bucket: string, options: BucketWebsiteOptions): Promise
deleteObjects(service: string, credential: unknown, bucket: string, options: DeleteObjectsOptions): Promise
deleteObjects(service: string, credential: unknown, bucket: string, recursive?: boolean | DeleteObjectsOptions): Promise
copyObject(service: string, credential: unknown, bucketSource: string, keySource: string, bucket: string, key: string, options?: CopyObjectOptions): Promise
uploadObject(service: string, credential: unknown, bucket: string, upload: CloudStorageUpload, localUri: string, beforeResolve?: ((value: string) => Promise
downloadObject(service: string, credential: unknown, bucket: string, download: CloudStorageDownload, beforeResolve?: ((value: Buffer | string | null) => Promise
getStorage(action: CloudFunctions, data: CloudStorage[] | undefined): CloudStorage | undefined;
hasStorage(action: CloudFunctions, storage: CloudStorage): CloudStorageUpload | false;
getDatabaseRows(item: CloudDatabase, ignoreErrors: boolean, sessionKey?: string): Promise
getDatabaseRows(item: CloudDatabase, sessionKey?: string): Promise
getDatabaseBatchRows(batch: CloudDatabase[], ignoreErrors: boolean, sessionKey?: string): Promise
getDatabaseBatchRows(batch: CloudDatabase[], sessionKey?: string): Promise
hasCredential(feature: CloudFeatures, data: CloudService, credential?: unknown): boolean;
getCredential(item: CloudService, unused?: boolean): Record
getSettings(service: string): Record
settingsOf(service: string, name: "coerce", component: keyof DbCoerceSettings): unknown;
settingsOf(service: string, name: "auth", component: keyof CloudAuthSettings): unknown;
getUploadHandler(service: string, credential: unknown): (...args: unknown[]) => void;
getDownloadHandler(service: string, credential: unknown): (...args: unknown[]) => void;
resolveService(service: string, folder?: string): string;
get settings(): CloudSettings;
}
interface CloudConstructor extends ClientDbConstructor
LOG_CLOUD_SUCCESS: LogMessageOptions;
LOG_CLOUD_FAIL: LogMessageOptions;
LOG_CLOUD_COMMAND: LogMessageOptions;
LOG_CLOUD_WARN: LogMessageOptions;
LOG_CLOUD_UPLOAD: LogMessageOptions;
LOG_CLOUD_DOWNLOAD: LogMessageOptions;
LOG_CLOUD_DELETE: LogMessageOptions;
LOG_CLOUD_DELAYED: LogMessageOptions;
finalize(this: IHost, instance: ICloud): Promise
uploadAsset(state: IScopeOrigin
uploadAsset(state: IScopeOrigin
uploadAsset(state: IScopeOrigin
uploadAssetSuccess(state: IScopeOrigin
sanitizeAssets(assets: ExternalAsset[]): ExternalAsset[];
optionsLogMessage(type: "SUCCESS" | "FAIL" | "COMMAND" | "WARN" | "UPLOAD" | "DOWNLOAD" | "DELETE" | "DELAYED", options?: LogMessageOptions & LogFailOptions): LogMessageOptions & LogFailOptions;
readonly prototype: ICloud;
new(module?: CloudModule, database?: CloudDatabase[], ...args: unknown[]): ICloud;
}
interface ICloudServiceClient {
CLOUD_SERVICE_NAME: string;
CLOUD_UPLOAD_DISK?: boolean;
CLOUD_UPLOAD_STREAM?: boolean;
CLOUD_UPLOAD_CHUNK?: boolean;
CLOUD_DOWNLOAD_CHUNK?: boolean;
validateStorage?(credential: unknown, data?: CloudService): boolean;
validateDatabase?(credential: unknown, data?: CloudService): boolean;
createStorageClient?(this: IModule, credential: unknown, service?: string): unknown;
createDatabaseClient?(this: IModule, credential: unknown, data?: CloudService): unknown;
/* @deprecated /
createBucket?(this: IModule, credential: unknown, bucket: string, publicRead?: boolean, service?: string, sdk?: string): Promise
createBucketV2?(this: IModule, credential: unknown, bucket: string, acl?: unknown, options?: unknown, service?: string, sdk?: string): Promise
setBucketPolicy?(this: IModule, credential: unknown, bucket: string, options: unknown, service?: string, sdk?: string): Promise
setBucketTagging?(this: IModule, credential: unknown, bucket: string, options: unknown, service?: string, sdk?: string): Promise
setBucketWebsite?(this: IModule, credential: unknown, bucket: string, options: BucketWebsiteOptions, service?: string, sdk?: string): Promise
/* @deprecated /
deleteObjects?(this: IModule, credential: unknown, bucket: string, service?: string, sdk?: string, recursive?: boolean): Promise
/* @deprecated /
deleteObjectsV2?(this: IModule, credential: unknown, bucket: string, recursive?: boolean, service?: string, sdk?: string): Promise
deleteObjectsV3?(this: IModule, credential: U, bucket: string, options?: DeleteObjectsOptions, service?: string, sdk?: string): Promise
copyObject?(this: IModule, credential: U, bucketSource: string, keySource: string, bucket: string, key: string, options?: unknown, service?: string, sdk?: string): Promise
executeQuery?(this: ICloud, credential: unknown, data: CloudDatabase, sessionKey?: string): Promise
executeBatchQuery?(this: ICloud, credential: unknown, batch: CloudDatabase[], sessionKey?: string): Promise
}
`
`typescript
import type { PermittedDirectories } from "./core";
import type { CloudServiceOptions, DbSourceOptions, PurgeComponent } from "./settings";
interface CloudModule {
// handler: "@e-mc/cloud";
extensions?: string[];
atlas?: CloudStoredCredentials;
aws?: CloudStoredCredentials;
"aws-v3"?: CloudStoredCredentials;
azure?: CloudStoredCredentials; // az
gcp?: CloudStoredCredentials; // gcloud
oci?: CloudStoredCredentials;
settings?: {
broadcast_id?: string | string[];
users?: Record
cache_dir?: string;
session_expires?: number;
user_key?: Record
imports?: StringMap;
purge?: PurgeComponent;
atlas?: CloudServiceOptions;
aws?: CloudServiceOptions;
"aws-v3"?: CloudServiceOptions;
azure?: CloudServiceOptions;
gcp?: CloudServiceOptions;
oci?: CloudServiceOptions;
};
permission?: PermittedDirectories;
}
type CloudStoredCredentials = Record
`
`javascript
const Cloud = require("@e-mc/cloud"); // Using @pi-r/aws
const instance = new Cloud({
aws: {
main: {
accessKeyId: "",
secretAccessKey: ""
}
},
"aws-v3": {
main: {
credentials: {
accessKeyId: "",
secretAccessKey: "",
region: "ap-northeast-1"
}
}
}
});
// instance.host = new Host();
instance.init();
const options = {
contentType: "application/tar",
acl: "authenticated-read",
chunkSize: "8mb",
overwrite: false, // Default
tags: { key_1: "value", key_2: "value" }
};
Promise.all([
// nodejs-001/archive.tar
instance.uploadObject("aws", "main", "nodejs-001", options, "/tmp/archive.tar"),
// nodejs-001/2024/01-01.tar
instance.uploadObject("aws", "main", "nodejs-001", { ...options, publicRead: true, pathname: "2024", filename: "01-01.tar" }, "/tmp/archive.tar"),
// nodejs-001/archive_1.tar
instance.uploadObject("aws", { accessKeyId: "", secretAccessKey: "" }, "nodejs-001", { overwrite: false }, "/tmp/archive.tar")
]);
const rows = await instance.getDatabaseRows({ service: "aws-v3", credential: "main", table: "demo", key: { id: 1 } });
``
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/asset.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/cloud.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/core.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/db.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/logger.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/settings.d.ts
BSD 3-Clause