nec-oss 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+import { AdapterLifecycleContext, AdapterUploadContext, AdapterUploadResult, AddResult, CustomValidator, FileLike, InvalidFile, MaybePromise, MaybePromise as MaybePromise$1, PreparedUpload, QueueEventHandler, QueueEventName, QueueEvents, StsToken, StsToken as StsToken$1, UploadAdapter, UploadAdapter as UploadAdapter$1, UploadContext, UploadContext as UploadContext$1, UploadError, UploadFile, UploadFile as UploadFile$1, UploadHttpRequest, UploadHttpRequest as UploadHttpRequest$1, UploadLifecycle, UploadLifecycle as UploadLifecycle$1, UploadParams, UploadParams as UploadParams$1, UploadProgress, UploadProvider, UploadProvider as UploadProvider$1, UploadResult, UploadStatus, UploadTask, UploadValidateOptions, UploadValidatorContext, Uploader, Uploader as Uploader$1, UploaderOptions, UploaderOptions as UploaderOptions$1, ValidationResult } from "@nec-oss/core";
+
+//#region src/oss/types.d.ts
+interface OssClientContext {
+  lifecycle: Extract<UploadLifecycle$1, 'sts'>;
+}
+type OssStsContext = UploadContext$1 | OssClientContext;
+type BeforeStsTokenReq = (request: UploadHttpRequest$1, context: UploadContext$1) => MaybePromise$1<UploadHttpRequest$1>;
+type BeforeStsTokenRes = (response: unknown, context: UploadContext$1) => MaybePromise$1<StsToken$1>;
+type RequestStsToken = (request: UploadHttpRequest$1, context: UploadContext$1) => MaybePromise$1<unknown>;
+type RefreshStsToken = (context: UploadContext$1) => MaybePromise$1<OssRefreshStsTokenResult>;
+type BeforeRefreshStsTokenReq = (request: UploadHttpRequest$1, context: UploadContext$1) => MaybePromise$1<UploadHttpRequest$1>;
+type RequestRefreshStsToken = (request: UploadHttpRequest$1, context: UploadContext$1) => MaybePromise$1<unknown>;
+type BeforeRefreshStsTokenRes = (response: unknown, context: UploadContext$1) => MaybePromise$1<OssRefreshStsTokenResult>;
+type BeforeUploadReq = (params: UploadParams$1, context: UploadContext$1) => MaybePromise$1<UploadParams$1>;
+type UploadResponseTransform<TUploadResponse = unknown> = (response: unknown, context: UploadContext$1) => MaybePromise$1<TUploadResponse>;
+interface OssProviderOptions<TUploadResponse = unknown> extends OssAdapterOptions {
+  stsUrl?: string;
+  uploadPrefix?: string;
+  mime?: string;
+  callback?: unknown;
+  extra?: Record<string, unknown>;
+  keyResolver?: (file: UploadFile$1, context: UploadContext$1) => MaybePromise$1<string>;
+  beforeStsTokenReq?: BeforeStsTokenReq;
+  beforeStsTokenRes?: BeforeStsTokenRes;
+  requestStsToken?: RequestStsToken;
+  refreshStsUrl?: string;
+  beforeRefreshStsTokenReq?: BeforeRefreshStsTokenReq;
+  requestRefreshStsToken?: RequestRefreshStsToken;
+  beforeRefreshStsTokenRes?: BeforeRefreshStsTokenRes;
+  refreshStsToken?: RefreshStsToken;
+  beforeUploadReq?: BeforeUploadReq;
+  response?: UploadResponseTransform<TUploadResponse>;
+  transformLifecycleRequest?: (request: UploadHttpRequest$1, context: UploadContext$1) => MaybePromise$1<UploadHttpRequest$1>;
+}
+interface CreateOssClientOptions extends OssAdapterOptions {
+  stsUrl?: string;
+  beforeStsTokenReq?: (request: UploadHttpRequest$1, context: OssClientContext) => MaybePromise$1<UploadHttpRequest$1>;
+  beforeStsTokenRes?: (response: unknown, context: OssClientContext) => MaybePromise$1<StsToken$1>;
+  requestStsToken?: (request: UploadHttpRequest$1, context: OssClientContext) => MaybePromise$1<unknown>;
+  refreshStsUrl?: string;
+  beforeRefreshStsTokenReq?: (request: UploadHttpRequest$1, context: OssClientContext) => MaybePromise$1<UploadHttpRequest$1>;
+  requestRefreshStsToken?: (request: UploadHttpRequest$1, context: OssClientContext) => MaybePromise$1<unknown>;
+  beforeRefreshStsTokenRes?: (response: unknown, context: OssClientContext) => MaybePromise$1<OssRefreshStsTokenResult>;
+  refreshStsToken?: (context: OssClientContext) => MaybePromise$1<OssRefreshStsTokenResult>;
+}
+interface OssAdapterOptions {
+  region?: string;
+  bucket?: string;
+  endpoint?: string;
+  cname?: boolean;
+  secure?: boolean;
+  timeout?: number | string;
+  authorizationV4?: boolean;
+  partSize?: number;
+  parallel?: number;
+  loadSdk?: () => MaybePromise$1<OssClientConstructor>;
+}
+interface OssCheckpoint {
+  name?: string;
+  uploadId?: string;
+  file?: File | Blob;
+  doneParts?: unknown[];
+  [key: string]: unknown;
+}
+interface OssRuntimeConfig {
+  bucket: string;
+  region: string;
+  endpoint?: string;
+  cname?: boolean;
+  secure?: boolean;
+}
+interface OssClientConstructor {
+  new (options: OssClientOptions): OssClient;
+}
+interface OssClient {
+  abortMultipartUpload(name: string, uploadId: string): Promise<unknown>;
+  multipartUpload(name: string, file: Blob, options?: Record<string, unknown>): OssMultipartUploadPromise;
+  [method: string]: any;
+}
+interface OssClientOptions {
+  accessKeyId: string;
+  accessKeySecret: string;
+  authorizationV4?: boolean;
+  bucket: string;
+  cname?: boolean;
+  endpoint?: string;
+  region: string;
+  secure?: boolean;
+  stsToken: string;
+  timeout?: number | string;
+  refreshSTSToken?: () => MaybePromise$1<OssRefreshStsTokenResult>;
+}
+interface OssMultipartUploadPromise extends Promise<unknown> {
+  cancel?: () => void;
+}
+interface OssRefreshStsTokenResult {
+  accessKeyId: string;
+  accessKeySecret: string;
+  stsToken: string;
+}
+//#endregion
+//#region src/oss/runtime.d.ts
+declare const DEFAULT_OSS_STS_URL = "/education/serverApi/oss-sts/token";
+declare function getOssRuntimeConfig(token: StsToken$1): OssRuntimeConfig;
+//#endregion
+//#region src/oss/provider.d.ts
+declare function createOssProvider(options?: OssProviderOptions): UploadProvider$1;
+//#endregion
+//#region src/oss/adapter.d.ts
+declare function createOssAdapter(options: OssAdapterOptions): UploadAdapter$1;
+//#endregion
+//#region src/oss/client.d.ts
+declare function createOssClient(options?: CreateOssClientOptions): Promise<OssClient>;
+//#endregion
+//#region src/uploader.d.ts
+type CreateOssUploaderOptions = Partial<UploaderOptions$1>;
+declare function createOssUploader(options?: CreateOssUploaderOptions): Uploader$1;
+declare function setDefaultOssProviderOptions(options: OssProviderOptions): void;
+//#endregion
+export { type AdapterLifecycleContext, type AdapterUploadContext, type AdapterUploadResult, type AddResult, type BeforeRefreshStsTokenReq, type BeforeRefreshStsTokenRes, type BeforeStsTokenReq, type BeforeStsTokenRes, type BeforeUploadReq, type CreateOssClientOptions, type CreateOssUploaderOptions, type CustomValidator, DEFAULT_OSS_STS_URL, type FileLike, type InvalidFile, type MaybePromise, type OssAdapterOptions, type OssCheckpoint, type OssClient, type OssClientConstructor, type OssClientContext, type OssClientOptions, type OssMultipartUploadPromise, type OssProviderOptions, type OssRefreshStsTokenResult, type OssRuntimeConfig, type OssStsContext, type PreparedUpload, type QueueEventHandler, type QueueEventName, type QueueEvents, type RefreshStsToken, type RequestRefreshStsToken, type RequestStsToken, type StsToken, type UploadAdapter, type UploadContext, type UploadError, type UploadFile, type UploadHttpRequest, type UploadLifecycle, type UploadParams, type UploadProgress, type UploadProvider, type UploadResponseTransform, type UploadResult, type UploadStatus, type UploadTask, type UploadValidateOptions, type UploadValidatorContext, type Uploader, type UploaderOptions, type ValidationResult, createOssAdapter, createOssClient, createOssProvider, createOssUploader, getOssRuntimeConfig, setDefaultOssProviderOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/oss/types.ts","../src/oss/runtime.ts","../src/oss/provider.ts","../src/oss/adapter.ts","../src/oss/client.ts","../src/uploader.ts"],"sourcesContent":[],"mappings":";;;UAUiB,gBAAA;aACJ,QAAQ;AADrB;AAIY,KAAA,aAAA,GAAgB,eAAA,GAAgB,gBAAA;AAEhC,KAAA,iBAAA,GAAiB,CAAA,OAAA,EAClB,mBADkB,EAAA,OAAA,EAElB,eAFkB,EAAA,GAGxB,cAHwB,CAGX,mBAHW,CAAA;AAClB,KAIC,iBAAA,GAJD,CAAA,QAAA,EAAA,OAAA,EAAA,OAAA,EAMA,eANA,EAAA,GAON,cAPM,CAOO,UAPP,CAAA;AACA,KAQC,eAAA,GARD,CAAA,OAAA,EASA,mBATA,EAAA,OAAA,EAUA,eAVA,EAAA,GAWN,cAXM,CAAA,OAAA,CAAA;AACO,KAYN,eAAA,GAZM,CAAA,OAAA,EAaP,eAbO,EAAA,GAcb,cAda,CAcA,wBAdA,CAAA;AAAb,KAgBO,wBAAA,GAhBP,CAAA,OAAA,EAiBM,mBAjBN,EAAA,OAAA,EAkBM,eAlBN,EAAA,GAmBA,cAnBA,CAmBa,mBAnBb,CAAA;AAAY,KAqBL,sBAAA,GArBK,CAAA,OAAA,EAsBN,mBAtBM,EAAA,OAAA,EAuBN,eAvBM,EAAA,GAwBZ,cAxBY,CAAA,OAAA,CAAA;AAEL,KAwBA,wBAAA,GAxBiB,CAAA,QAAA,EAAA,OAAA,EAAA,OAAA,EA0BlB,eA1BkB,EAAA,GA2BxB,cA3BwB,CA2BX,wBA3BW,CAAA;AAElB,KA2BC,eAAA,GA3BD,CAAA,MAAA,EA4BD,cA5BC,EAAA,OAAA,EA6BA,eA7BA,EAAA,GA8BN,cA9BM,CA8BO,cA9BP,CAAA;AACO,KA+BN,uBA/BM,CAAA,kBAAA,OAAA,CAAA,GAAA,CAAA,QAAA,EAAA,OAAA,EAAA,OAAA,EAiCP,eAjCO,EAAA,GAkCb,cAlCa,CAkCA,eAlCA,CAAA;AAAb,UAoCY,kBApCZ,CAAA,kBAAA,OAAA,CAAA,SAoCkE,iBApClE,CAAA;EAAY,MAAA,CAAA,EAAA,MAAA;EAEL,YAAA,CAAA,EAAA,MAAe;EAChB,IAAA,CAAA,EAAA,MAAA;EACA,QAAA,CAAA,EAAA,OAAA;EACN,KAAA,CAAA,EAoCK,MApCL,CAAA,MAAA,EAAA,OAAA,CAAA;EAAY,WAAA,CAAA,EAAA,CAAA,IAAA,EAqCM,YArCN,EAAA,OAAA,EAqC2B,eArC3B,EAAA,GAqC6C,cArC7C,CAAA,MAAA,CAAA;EAEL,iBAAA,CAAe,EAoCL,iBApCK;EAChB,iBAAA,CAAA,EAoCW,iBApCX;EACO,eAAA,CAAA,EAoCE,eApCF;EAAb,aAAA,CAAA,EAAA,MAAA;EAAY,wBAAA,CAAA,EAsCY,wBAtCZ;EAEL,sBAAA,CAAA,EAqCe,sBArCS;EACzB,wBAAA,CAAA,EAqCkB,wBArClB;EACA,eAAA,CAAA,EAqCS,eArCT;EACO,eAAA,CAAA,EAqCE,eArCF;EAAb,QAAA,CAAA,EAsCQ,uBAtCR,CAsCgC,eAtChC,CAAA;EAAY,yBAAA,CAAA,EAAA,CAAA,OAAA,EAwCJ,mBAxCI,EAAA,OAAA,EAyCJ,eAzCI,EAAA,GA0CV,cA1CU,CA0CG,mBA1CH,CAAA;AAEjB;AACW,UA0CM,sBAAA,SAA+B,iBA1CrC,CAAA;EACA,MAAA,CAAA,EAAA,MAAA;EACN,iBAAA,CAAA,EAAA,CAAA,OAAA,EA2CQ,mBA3CR,EAAA,OAAA,EA4CQ,gBA5CR,EAAA,GA6CE,cA7CF,CA6Ce,mBA7Cf,CAAA;EAAY,iBAAA,CAAA,EAAA,CAAA,QAAA,EAAA,OAAA,EAAA,OAAA,EAgDJ,gBAhDI,EAAA,GAiDV,cAjDU,CAiDG,UAjDH,CAAA;EAEL,eAAA,CAAA,EAAA,CAAA,OAAA,EAiDC,mBAjDuB,EAAA,OAAA,EAkDvB,gBAlDuB,EAAA,GAmD7B,cAnD6B,CAAA,OAAA,CAAA;EAEzB,aAAA,CAAA,EAAA,MAAA;EACO,wBAAA,CAAA,EAAA,CAAA,OAAA,EAmDL,mBAnDK,EAAA,OAAA,EAoDL,gBApDK,EAAA,GAqDX,cArDW,CAqDE,mBArDF,CAAA;EAAb,sBAAA,CAAA,EAAA,CAAA,OAAA,EAuDQ,mBAvDR,EAAA,OAAA,EAwDQ,gBAxDR,EAAA,GAyDE,cAzDF,CAAA,OAAA,CAAA;EAAY,wBAAA,CAAA,EAAA,CAAA,QAAA,EAAA,OAAA,EAAA,OAAA,EA4DJ,gBA5DI,EAAA,GA6DV,cA7DU,CA6DG,wBA7DH,CAAA;EAEL,eAAA,CAAA,EAAe,CAAA,OAAA,EA6Dd,gBA7Dc,EAAA,GA8DpB,cA9DoB,CA8DP,wBA9DO,CAAA;;AAEhB,UA+DM,iBAAA,CA/DN;EACO,MAAA,CAAA,EAAA,MAAA;EAAb,MAAA,CAAA,EAAA,MAAA;EAAY,QAAA,CAAA,EAAA,MAAA;EAEL,KAAA,CAAA,EAAA,OAAA;EAED,MAAA,CAAA,EAAA,OAAA;EACO,OAAA,CAAA,EAAA,MAAA,GAAA,MAAA;EAAb,eAAA,CAAA,EAAA,OAAA;EAAY,QAAA,CAAA,EAAA,MAAA;EAEA,QAAA,CAAA,EAAA,MAAA;EAKP,OAAA,CAAA,EAAA,GAAA,GA4DQ,cA5DR,CA4DqB,oBA5DrB,CAAA;;AACkC,UA8D3B,aAAA,CA9D2B;EAAkB,IAAA,CAAA,EAAA,MAAA;EACxC,QAAA,CAAA,EAAA,MAAA;EACA,IAAA,CAAA,EA+Db,IA/Da,GA+DN,IA/DM;EACF,SAAA,CAAA,EAAA,OAAA,EAAA;EAES,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;;AAKQ,UAgEpB,gBAAA,CAhEoB;EAAxB,MAAA,EAAA,MAAA;EAEA,MAAA,EAAA,MAAA;EACA,QAAA,CAAA,EAAA,MAAA;EACO,KAAA,CAAA,EAAA,OAAA;EAAb,MAAA,CAAA,EAAA,OAAA;;AApBiF,UAwFvE,oBAAA,CAxFuE;EAuBvE,KAAA,OAAA,EAkED,gBAlEwB,CAAA,EAkEL,SAlEK;;AAI3B,UAiEI,SAAA,CAjEJ;EACO,oBAAA,CAAA,IAAA,EAAA,MAAA,EAAA,QAAA,EAAA,MAAA,CAAA,EAiEoC,OAjEpC,CAAA,OAAA,CAAA;EAAb,eAAA,CAAA,IAAA,EAAA,MAAA,EAAA,IAAA,EAkE+B,IAlE/B,EAAA,OAAA,CAAA,EAkE+C,MAlE/C,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,EAkEyE,yBAlEzE;EAGM,CAAA,MAAA,EAAA,MAAA,CAAA,EAAA,GAAA;;AACN,UAkEU,gBAAA,CAlEV;EAEM,WAAA,EAAA,MAAA;EACA,eAAA,EAAA,MAAA;EACN,eAAA,CAAA,EAAA,OAAA;EAGM,MAAA,EAAA,MAAA;EACA,KAAA,CAAA,EAAA,OAAA;EACO,QAAA,CAAA,EAAA,MAAA;EAAb,MAAA,EAAA,MAAA;EAEM,MAAA,CAAA,EAAA,OAAA;EACA,QAAA,EAAA,MAAA;EACN,OAAA,CAAA,EAAA,MAAA,GAAA,MAAA;EAGM,eAAA,CAAA,EAAA,GAAA,GA6Da,cA7Db,CA6D0B,wBA7D1B,CAAA;;AACN,UA+DU,yBAAA,SAAkC,OA/D5C,CAAA,OAAA,CAAA,CAAA;EAEM,MAAA,CAAA,EAAA,GAAA,GAAA,IAAA;;AACN,UAgEU,wBAAA,CAhEV;EA7ByC,WAAA,EAAA,MAAA;EAAiB,eAAA,EAAA,MAAA;EAgChD,QAAA,EAAA,MAAA;AAajB;;;AAxGkB,cCeL,mBAAA,GDfK,oCAAA;AAKb,iBCiGW,mBAAA,CDjGX,KAAA,ECiGsC,UDjGtC,CAAA,ECiGiD,gBDjGjD;;;AAnBY,iBESD,iBAAA,CFRK,OAAD,CAAC,EEQsB,kBFRvB,CAAA,EEQiD,gBFRjD;;;iBGIJ,gBAAA,UAA0B,oBAAoB;;;iBCX9C,eAAA,WAAyB,yBAA8B,QAAQ;;;KCGnE,wBAAA,GAA2B,QAAQ;ALG9B,iBKCD,iBAAA,CLAK,OAAD,CAAC,EKAsB,wBLAvB,CAAA,EKAuD,ULAvD;AAGR,iBKII,4BAAA,CLJ4B,OAAA,EKIU,kBLJM,CAAA,EAAA,IAAA"}