@epilot/file-client 1.11.0 → 1.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
File without changes
package/dist/client.js CHANGED
File without changes
File without changes
File without changes
package/dist/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
- export type { Client, Components, Paths, PathsDictionary, OperationMethods } from './openapi';
2
1
  export type { OpenAPIClient, OpenAPIClientAxios, Document } from 'openapi-client-axios';
3
2
  export * from './client';
3
+ export * from './openapi';
package/dist/index.js CHANGED
@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./client"), exports);
18
+ __exportStar(require("./openapi"), exports);
18
19
  //# sourceMappingURL=index.js.map
package/dist/openapi.d.ts CHANGED
@@ -1,11 +1,12 @@
1
1
  /* eslint-disable */
2
+
2
3
  import type {
3
4
  OpenAPIClient,
4
5
  Parameters,
5
6
  UnknownParamsObject,
6
7
  OperationResponse,
7
8
  AxiosRequestConfig,
8
- } from 'openapi-client-axios';
9
+ } from 'openapi-client-axios';
9
10
 
10
11
  declare namespace Components {
11
12
  namespace Schemas {
@@ -286,6 +287,12 @@ declare namespace Components {
286
287
  * application/pdf
287
288
  */
288
289
  mime_type?: string;
290
+ /**
291
+ * Used to index the file at the storage layer, which helps when browsing for this file
292
+ * example:
293
+ * 2f6a377c8e78
294
+ */
295
+ index_tag?: string;
289
296
  /**
290
297
  * Allows passing in custom metadata for the file, expects key-value pairs of string type
291
298
  * example:
@@ -720,7 +727,7 @@ export interface OperationMethods {
720
727
  * Generate pre-signed download S3 url for a file
721
728
  */
722
729
  'downloadFile'(
723
- parameters?: Parameters<Paths.DownloadFile.PathParameters & Paths.DownloadFile.QueryParameters> | null,
730
+ parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
724
731
  data?: any,
725
732
  config?: AxiosRequestConfig
726
733
  ): OperationResponse<Paths.DownloadFile.Responses.$200>
@@ -760,7 +767,7 @@ export interface OperationMethods {
760
767
  * Generate thumbnail preview for a file entity
761
768
  */
762
769
  'previewFile'(
763
- parameters?: Parameters<Paths.PreviewFile.PathParameters & Paths.PreviewFile.QueryParameters> | null,
770
+ parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
764
771
  data?: any,
765
772
  config?: AxiosRequestConfig
766
773
  ): OperationResponse<any>
@@ -770,7 +777,7 @@ export interface OperationMethods {
770
777
  * Generate thumbnail preview for a public file entity
771
778
  */
772
779
  'previewPublicFile'(
773
- parameters?: Parameters<Paths.PreviewPublicFile.PathParameters & Paths.PreviewPublicFile.QueryParameters> | null,
780
+ parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
774
781
  data?: any,
775
782
  config?: AxiosRequestConfig
776
783
  ): OperationResponse<any>
@@ -953,7 +960,7 @@ export interface PathsDictionary {
953
960
  * Generate pre-signed download S3 url for a file
954
961
  */
955
962
  'get'(
956
- parameters?: Parameters<Paths.DownloadFile.PathParameters & Paths.DownloadFile.QueryParameters> | null,
963
+ parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
957
964
  data?: any,
958
965
  config?: AxiosRequestConfig
959
966
  ): OperationResponse<Paths.DownloadFile.Responses.$200>
@@ -1001,7 +1008,7 @@ export interface PathsDictionary {
1001
1008
  * Generate thumbnail preview for a file entity
1002
1009
  */
1003
1010
  'get'(
1004
- parameters?: Parameters<Paths.PreviewFile.PathParameters & Paths.PreviewFile.QueryParameters> | null,
1011
+ parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
1005
1012
  data?: any,
1006
1013
  config?: AxiosRequestConfig
1007
1014
  ): OperationResponse<any>
@@ -1013,7 +1020,7 @@ export interface PathsDictionary {
1013
1020
  * Generate thumbnail preview for a public file entity
1014
1021
  */
1015
1022
  'get'(
1016
- parameters?: Parameters<Paths.PreviewPublicFile.PathParameters & Paths.PreviewPublicFile.QueryParameters> | null,
1023
+ parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1017
1024
  data?: any,
1018
1025
  config?: AxiosRequestConfig
1019
1026
  ): OperationResponse<any>
@@ -1159,3 +1166,22 @@ export interface PathsDictionary {
1159
1166
  }
1160
1167
 
1161
1168
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1169
+
1170
+ export type CommonSaveFilePayload = Components.Schemas.CommonSaveFilePayload;
1171
+ export type DeleteFilePayload = Components.Schemas.DeleteFilePayload;
1172
+ export type DownloadFilesPayload = Components.Schemas.DownloadFilesPayload;
1173
+ export type EntityId = Components.Schemas.EntityId;
1174
+ export type EntitySlug = Components.Schemas.EntitySlug;
1175
+ export type FileEntity = Components.Schemas.FileEntity;
1176
+ export type FileEntityId = Components.Schemas.FileEntityId;
1177
+ export type FileItem = Components.Schemas.FileItem;
1178
+ export type FileRelationItem = Components.Schemas.FileRelationItem;
1179
+ export type FileUpload = Components.Schemas.FileUpload;
1180
+ export type PublicLink = Components.Schemas.PublicLink;
1181
+ export type S3Reference = Components.Schemas.S3Reference;
1182
+ export type SaveCustomFilePayload = Components.Schemas.SaveCustomFilePayload;
1183
+ export type SaveFilePayload = Components.Schemas.SaveFilePayload;
1184
+ export type SaveFilePayloadV2 = Components.Schemas.SaveFilePayloadV2;
1185
+ export type SaveS3FilePayload = Components.Schemas.SaveS3FilePayload;
1186
+ export type UploadFilePayload = Components.Schemas.UploadFilePayload;
1187
+ export type VerifyCustomDownloadUrlPayload = Components.Schemas.VerifyCustomDownloadUrlPayload;
package/dist/openapi.json CHANGED
@@ -1071,6 +1071,12 @@
1071
1071
  "example": "application/pdf",
1072
1072
  "default": "application/octet-stream"
1073
1073
  },
1074
+ "index_tag": {
1075
+ "type": "string",
1076
+ "example": "2f6a377c8e78",
1077
+ "maxLength": 64,
1078
+ "description": "Used to index the file at the storage layer, which helps when browsing for this file"
1079
+ },
1074
1080
  "metadata": {
1075
1081
  "type": "object",
1076
1082
  "additionalProperties": {
@@ -1421,4 +1427,4 @@
1421
1427
  "url": "https://file.sls.epilot.io"
1422
1428
  }
1423
1429
  ]
1424
- }
1430
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/file-client",
3
- "version": "1.11.0",
3
+ "version": "1.13.0",
4
4
  "description": "Client library for the epilot File API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
11
11
  "typescript": "tsc",
12
12
  "bundle-definition": "webpack",
13
13
  "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/file.yaml",
14
- "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
14
+ "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
15
15
  "build": "tsc && npm run bundle-definition",
16
16
  "build:watch": "npm run build && tsc -w",
17
17
  "prepublishOnly": "npm run typegen && npm run build",
@@ -61,8 +61,7 @@
61
61
  "copy-webpack-plugin": "^7.0.0",
62
62
  "jest": "^26.6.3",
63
63
  "json-loader": "^0.5.7",
64
- "openapi-client-axios-typegen": "^7.4.1",
65
- "openapicmd": "^2.1.0",
64
+ "openapicmd": "^2.6.0",
66
65
  "ts-jest": "^26.5.0",
67
66
  "ts-loader": "^8.0.14",
68
67
  "ts-node": "^10.9.1",
@@ -70,5 +69,5 @@
70
69
  "webpack": "^5.18.0",
71
70
  "webpack-cli": "^4.4.0"
72
71
  },
73
- "gitHead": "25f84cc5cd8614b24fd23343697d70946768682f"
72
+ "gitHead": "6c12dc4aaf7ddf60ad11c6f596fb478559fa3052"
74
73
  }