@lokalise/file-storage-service-sdk - npm Package Compare versions

Comparing version 1.1.0 to 3.0.0

dist/lib/sdk/fileStorageClient.d.ts

 import type { Either } from '@lokalise/node-core/dist/src/errors/either';
-import type { FileDescription, FileMappingData, FileMetadata, FileUploadData, HttpRequestContext } from './model';
+import type { FileData, FileMappingData, FileMetadata, FileUploadData, HttpRequestContext } from './model';
 import type { ContentHeaders, ERROR_RESPONSE_SCHEMA_TYPE, UseCaseEnum } from './schema/storageSchemas';
@@ -22,4 +22,4 @@ import { StatisticsClient } from './statisticsClient';
     constructor(config: FileStorageClientConfig);
-    uploadFile(teamId: number, projectId: string, useCase: UseCaseEnum, fileDescription: FileDescription, bearerToken: string, contentHeaders: ContentHeaders, requestContext: HttpRequestContext): Promise<Either<ERROR_RESPONSE_SCHEMA_TYPE, string>>;
-    createUploadUrl(teamId: number, projectId: string, useCase: UseCaseEnum, fileDescription: FileDescription, requestContext: HttpRequestContext, contentHeaders: ContentHeaders): Promise<Either<ERROR_RESPONSE_SCHEMA_TYPE, FileUploadData>>;
+    uploadFile(teamId: number, projectId: string, useCase: UseCaseEnum, fileData: FileData, contentHeaders: ContentHeaders, requestContext: HttpRequestContext): Promise<Either<ERROR_RESPONSE_SCHEMA_TYPE, string>>;
+    createUploadUrl(teamId: number, projectId: string, useCase: UseCaseEnum, fileData: FileData, requestContext: HttpRequestContext, contentHeaders: ContentHeaders): Promise<Either<ERROR_RESPONSE_SCHEMA_TYPE, FileUploadData>>;
     getFileMetadata(teamId: number, projectId: string, useCase: UseCaseEnum, fileId: string, requestContext: HttpRequestContext): Promise<Either<ERROR_RESPONSE_SCHEMA_TYPE, FileMetadata>>;
@@ -35,2 +35,3 @@ getFileDownloadUrl(teamId: number, projectId: string, fileId: string, useCase: UseCaseEnum, requestContext: HttpRequestContext): Promise<Either<ERROR_RESPONSE_SCHEMA_TYPE, string>>;
     private getFileIdMappingEndpoint;
+    private createBearerAuth;
 }

dist/lib/sdk/fileStorageClient.js

@@ -23,4 +23,4 @@ "use strict";
     }
-    async uploadFile(teamId, projectId, useCase, fileDescription, bearerToken, contentHeaders, requestContext) {
-        const { error, result } = await this.createUploadUrl(teamId, projectId, useCase, fileDescription, requestContext, contentHeaders);
+    async uploadFile(teamId, projectId, useCase, fileData, contentHeaders, requestContext) {
+        const { error, result } = await this.createUploadUrl(teamId, projectId, useCase, fileData, requestContext, contentHeaders);
         if (error)
@@ -37,3 +37,3 @@ return { error: error };
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument,@typescript-eslint/no-unsafe-call
-        (0, node_core_1.buildClient)(uploadBaseUrl), uploadUrlObject.pathname, fileDescription.fileData, {
+        (0, node_core_1.buildClient)(uploadBaseUrl), uploadUrlObject.pathname, fileData.file, {
             headers,
@@ -49,4 +49,4 @@ safeParseJson: true,
     }
-    async createUploadUrl(teamId, projectId, useCase, fileDescription, requestContext, contentHeaders) {
-        const { filename, mimeType, metadata } = fileDescription;
+    async createUploadUrl(teamId, projectId, useCase, fileData, requestContext, contentHeaders) {
+        const { filename, mimeType, metadata } = fileData;
         const body = {
@@ -60,3 +60,3 @@ metadata,
             headers: {
-                authorization: requestContext.jwtToken,
+                authorization: this.createBearerAuth(requestContext.jwtToken),
                 'Content-Type': 'application/json',
@@ -104,3 +104,3 @@ },
             headers: {
-                authorization: requestContext.jwtToken,
+                authorization: this.createBearerAuth(requestContext.jwtToken),
             },
@@ -120,3 +120,3 @@ safeParseJson: true,
             headers: {
-                authorization: requestContext.jwtToken,
+                authorization: this.createBearerAuth(requestContext.jwtToken),
             },
@@ -137,3 +137,3 @@ safeParseJson: true,
             headers: {
-                authorization: requestContext.jwtToken,
+                authorization: this.createBearerAuth(requestContext.jwtToken),
             },
@@ -178,4 +178,5 @@ safeParseJson: true,
     getFileIdMappingEndpoint = (teamId) => `/teams/${teamId}/mappings`;
+    createBearerAuth = (jwtToken) => `Bearer ${jwtToken}`;
 }
 exports.FileStorageClient = FileStorageClient;
 //# sourceMappingURL=fileStorageClient.js.map

dist/lib/sdk/fileStorageClient.spec.js

@@ -64,3 +64,3 @@ "use strict";
         await mockStorageServer.forPut(uploadPath).thenReply(200, '{}');
-        await expect(fileStorageClient.uploadFile(testFs_1.FS_TEST_DATA.TEAM_ID, testFs_1.FS_TEST_DATA.PROJECT_ID, 'bundles', testFs_1.FS_TEST_DATA.FILE_DESCRIPTION, testFs_1.FS_TEST_DATA.BEARER_TOKEN, {}, testFs_1.FS_TEST_DATA.REQUEST_CONTEXT)).resolves.toEqual({ result: fileId });
+        await expect(fileStorageClient.uploadFile(testFs_1.FS_TEST_DATA.TEAM_ID, testFs_1.FS_TEST_DATA.PROJECT_ID, 'bundles', testFs_1.FS_TEST_DATA.FILE_DESCRIPTION, {}, testFs_1.FS_TEST_DATA.REQUEST_CONTEXT)).resolves.toEqual({ result: fileId });
         await mockStorageServer.stop();
@@ -86,3 +86,3 @@ });
         await mockStorageServer.forPut(uploadUrl).withQuery({ key: 'token' }).thenReply(200, '{}');
-        await expect(fileStorageClient.uploadFile(testFs_1.FS_TEST_DATA.TEAM_ID, testFs_1.FS_TEST_DATA.PROJECT_ID, 'bundles', testFs_1.FS_TEST_DATA.FILE_DESCRIPTION, testFs_1.FS_TEST_DATA.BEARER_TOKEN, {}, testFs_1.FS_TEST_DATA.REQUEST_CONTEXT)).resolves.toEqual({ result: fileId });
+        await expect(fileStorageClient.uploadFile(testFs_1.FS_TEST_DATA.TEAM_ID, testFs_1.FS_TEST_DATA.PROJECT_ID, 'bundles', testFs_1.FS_TEST_DATA.FILE_DESCRIPTION, {}, testFs_1.FS_TEST_DATA.REQUEST_CONTEXT)).resolves.toEqual({ result: fileId });
         await mockStorageServer.stop();
@@ -100,3 +100,3 @@ });
         });
-        await expect(fileStorageClient.uploadFile(testFs_1.FS_TEST_DATA.TEAM_ID, testFs_1.FS_TEST_DATA.PROJECT_ID, 'bundles', testFs_1.FS_TEST_DATA.FILE_DESCRIPTION, testFs_1.FS_TEST_DATA.BEARER_TOKEN, {}, testFs_1.FS_TEST_DATA.REQUEST_CONTEXT)).resolves.toEqual({ error: testFs_1.FS_TEST_DATA.ERROR_REPLY });
+        await expect(fileStorageClient.uploadFile(testFs_1.FS_TEST_DATA.TEAM_ID, testFs_1.FS_TEST_DATA.PROJECT_ID, 'bundles', testFs_1.FS_TEST_DATA.FILE_DESCRIPTION, {}, testFs_1.FS_TEST_DATA.REQUEST_CONTEXT)).resolves.toEqual({ error: testFs_1.FS_TEST_DATA.ERROR_REPLY });
     });
@@ -130,3 +130,3 @@ it('returns error on uploading file by generated upload url', async () => {
         });
-        await expect(fileStorageClient.uploadFile(testFs_1.FS_TEST_DATA.TEAM_ID, testFs_1.FS_TEST_DATA.PROJECT_ID, 'bundles', testFs_1.FS_TEST_DATA.FILE_DESCRIPTION, testFs_1.FS_TEST_DATA.BEARER_TOKEN, {}, testFs_1.FS_TEST_DATA.REQUEST_CONTEXT)).resolves.toEqual({ error: testFs_1.FS_TEST_DATA.ERROR_REPLY });
+        await expect(fileStorageClient.uploadFile(testFs_1.FS_TEST_DATA.TEAM_ID, testFs_1.FS_TEST_DATA.PROJECT_ID, 'bundles', testFs_1.FS_TEST_DATA.FILE_DESCRIPTION, {}, testFs_1.FS_TEST_DATA.REQUEST_CONTEXT)).resolves.toEqual({ error: testFs_1.FS_TEST_DATA.ERROR_REPLY });
         await mockStorageServer.stop();
@@ -133,0 +133,0 @@ });

dist/lib/sdk/model.d.ts

 /// <reference types="node" />
+/// <reference types="node" />
+import type { Readable } from 'node:stream';
 import type { StatusEnum } from './schema/storageSchemas';
 export interface HttpRequestContext {
     reqId: string;
-    jwtToken?: string;
+    jwtToken: string;
 }
-export interface FileDescription {
+export interface FileData {
     filename: string;
-    fileData: Buffer;
+    file: Buffer | Readable;
     mimeType: string;
@@ -11,0 +13,0 @@ metadata?: Record<string, string>;

dist/test/fixtures/testFs.d.ts

@@ -9,3 +9,3 @@ /// <reference types="node" />
         filename: string;
-        fileData: Buffer;
+        file: Buffer;
         mimeType: string;
@@ -12,0 +12,0 @@ metadata: {

dist/test/fixtures/testFs.js

@@ -11,3 +11,3 @@ "use strict";
         filename: 'testFile.zip',
-        fileData: Buffer.from('UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==', 'base64'),
+        file: Buffer.from('UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==', 'base64'),
         mimeType: 'application/zip',
@@ -14,0 +14,0 @@ metadata: {

package.json

 {
   "name": "@lokalise/file-storage-service-sdk",
-  "version": "1.1.0",
+  "version": "3.0.0",
   "description": "SDK for file-storage-service",
@@ -41,3 +41,3 @@ "author": {
   "dependencies": {
-    "@lokalise/node-core": "^4.0.0",
+    "@lokalise/node-core": "^5.0.0",
     "@lokalise/zod-extras": "^1.3.1",
@@ -64,3 +64,3 @@ "undici": "^5.20.0",
     "ts-node": "^10.9.1",
-    "typescript": "4.9.5"
+    "typescript": "5.1.6"
   },
@@ -67,0 +67,0 @@ "engines": {

No alert changes

Improved metrics

Total package byte prevSize

83691

0.08%

Dependency changes

• + Added

  @lokalise/node-core@5.13.1
  (transitive)

• + Added

  abort-controller@3.0.0
  (transitive)

• + Added

  atomic-sleep@1.0.0
  (transitive)

• + Added

  base64-js@1.5.1
  (transitive)

• + Added

  buffer@6.0.3
  (transitive)

• + Added

  event-target-shim@5.0.1
  (transitive)

• + Added

  events@3.3.0
  (transitive)

• + Added

  fast-redact@3.5.0
  (transitive)

• + Added

  ieee754@1.2.1
  (transitive)

• + Added

  on-exit-leak-free@2.1.2
  (transitive)

• + Added

  pino@8.21.0
  (transitive)

• + Added

  pino-abstract-transport@1.2.0
  (transitive)

• + Added

  pino-std-serializers@6.2.2
  (transitive)

• + Added

  process@0.11.10
  (transitive)

• + Added

  process-warning@3.0.0
  (transitive)

• + Added

  quick-format-unescaped@4.0.4
  (transitive)

• + Added

  readable-stream@4.7.0
  (transitive)

• + Added

  real-require@0.2.0
  (transitive)

• + Added

  safe-buffer@5.2.1
  (transitive)

• + Added

  safe-stable-stringify@2.5.0
  (transitive)

• + Added

  sonic-boom@3.8.1
  (transitive)

• + Added

  split2@4.2.0
  (transitive)

• + Added

  string_decoder@1.3.0
  (transitive)

• + Added

  thread-stream@2.7.0
  (transitive)

• + Added

  undici-retry@2.1.0
  (transitive)

• - Removed

  @lokalise/node-core@4.1.1
  (transitive)

• - Removed

  undici-retry@1.1.1
  (transitive)

• Updated

  @lokalise/node-core@^5.0.0