@brostark/solutions-client 1.1.16 → 1.1.18

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.
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Generates an API to manage media
3
+ * @param apiUrl - The API URL
4
+ * @param apiKey - The API key for authentication
5
+ * @returns An object containing methods to interact with the media API
6
+ */
7
+ export declare const generateMediaAPI: (apiUrl: string, apiKey: string) => {
8
+ /**
9
+ * Uploads a new video
10
+ * @param file - The video file to upload
11
+ * @returns A promise with information about the uploaded video (URL and path)
12
+ */
13
+ upload: (file: File, filename: string) => Promise<any>;
14
+ };
15
+ //# sourceMappingURL=media.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"media.d.ts","sourceRoot":"","sources":["../../../src/api/v1/media.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM;IAE3D;;;;OAIG;mBACkB,IAAI,YAAY,MAAM;CAM9C,CAAA"}
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.generateMediaAPI = void 0;
4
+ const httpRequest_1 = require("../../lib/httpRequest");
5
+ /**
6
+ * Generates an API to manage media
7
+ * @param apiUrl - The API URL
8
+ * @param apiKey - The API key for authentication
9
+ * @returns An object containing methods to interact with the media API
10
+ */
11
+ const generateMediaAPI = (apiUrl, apiKey) => {
12
+ return {
13
+ /**
14
+ * Uploads a new video
15
+ * @param file - The video file to upload
16
+ * @returns A promise with information about the uploaded video (URL and path)
17
+ */
18
+ upload: async (file, filename) => {
19
+ const response = await (0, httpRequest_1.httpUploadRequest)(`${apiUrl}/media/${filename}`, apiKey, file);
20
+ return response.data;
21
+ },
22
+ };
23
+ };
24
+ exports.generateMediaAPI = generateMediaAPI;
@@ -1 +1 @@
1
- {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/api/v1/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAKjE;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM;IAE5D;;;;OAIG;gCAC8B,WAAW;IAK5C;;;;OAIG;+BAC8B,iBAAiB,CAAC,MAAM,CAAC,sBAAsB;IAMhF;;;;OAIG;6BAC4B,MAAM;IAMrC;;;;;OAKG;sCACqC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;IAMpF;;;;;OAKG;qCACoC,MAAM,cAAc,MAAM;IAMjE;;;;;OAKG;8CAC6C,MAAM,eAAe,MAAM,EAAE;IAM7E;;;;;OAKG;sCACqC,MAAM,cAAc,MAAM;IAMlE;;;;;OAKG;4BAC2B,MAAM,SAAS,iBAAiB,CAAC,MAAM,CAAC,WAAW,KAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC;CAcrI,CAAA"}
1
+ {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/api/v1/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAKjE;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM;IAE5D;;;;OAIG;gCAC8B,WAAW;IAK5C;;;;OAIG;+BAC8B,iBAAiB,CAAC,MAAM,CAAC,sBAAsB;IAMhF;;;;OAIG;6BAC4B,MAAM;IAMrC;;;;;OAKG;sCACqC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;IAMpF;;;;;OAKG;qCACoC,MAAM,cAAc,MAAM;IAMjE;;;;;OAKG;8CAC6C,MAAM,eAAe,MAAM,EAAE;IAM7E;;;;;OAKG;sCACqC,MAAM,cAAc,MAAM;IAMlE;;;;;OAKG;4BAC2B,MAAM,SAAS,iBAAiB,CAAC,MAAM,CAAC,WAAW,KAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC;CAgBrI,CAAA"}
@@ -87,7 +87,10 @@ const generateSearchAPI = (apiUrl, apiKey) => {
87
87
  query: async (collectionName, query) => {
88
88
  const urlQuery = {};
89
89
  Object.entries(query).forEach(([key, value]) => {
90
- if (value !== undefined && value !== null) {
90
+ if (Array.isArray(value)) {
91
+ urlQuery[key] = value.join(",");
92
+ }
93
+ else if (value !== undefined && value !== null) {
91
94
  urlQuery[key] = String(value);
92
95
  }
93
96
  });
package/dist/client.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { generateLiveAPI } from "./api/v1/live";
2
+ import { generateMediaAPI } from "./api/v1/media";
2
3
  import { generateSearchAPI } from "./api/v1/search";
3
4
  import { generateVideoAPI } from "./api/v1/video";
4
5
  import { ApiVersion } from "./constant";
@@ -14,6 +15,7 @@ export interface CreateClientOptions {
14
15
  export interface BrostarkSolutionsClient {
15
16
  live: ReturnType<typeof generateLiveAPI>;
16
17
  video: ReturnType<typeof generateVideoAPI>;
18
+ media: ReturnType<typeof generateMediaAPI>;
17
19
  search: ReturnType<typeof generateSearchAPI>;
18
20
  }
19
21
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAyC,MAAM,YAAY,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;IACzC,KAAK,EAAE,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;IAC3C,MAAM,EAAE,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;CAC9C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB,GAAG,uBAAuB,CAavG"}
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAyC,MAAM,YAAY,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;IACzC,KAAK,EAAE,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;IAC3C,KAAK,EAAE,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;IAC3C,MAAM,EAAE,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;CAC9C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB,GAAG,uBAAuB,CAcvG"}
package/dist/client.js CHANGED
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.createClient = createClient;
4
4
  const live_1 = require("./api/v1/live");
5
+ const media_1 = require("./api/v1/media");
5
6
  const search_1 = require("./api/v1/search");
6
7
  const video_1 = require("./api/v1/video");
7
8
  const constant_1 = require("./constant");
@@ -16,6 +17,7 @@ function createClient(apiKey, options = {}) {
16
17
  const apiUrl = `${host}/${version}`;
17
18
  return {
18
19
  live: (0, live_1.generateLiveAPI)(apiUrl, apiKey),
20
+ media: (0, media_1.generateMediaAPI)(apiUrl, apiKey),
19
21
  video: (0, video_1.generateVideoAPI)(apiUrl, apiKey),
20
22
  search: (0, search_1.generateSearchAPI)(apiUrl, apiKey),
21
23
  };
@@ -26,6 +26,11 @@ export declare namespace BrostarkSolutions {
26
26
  defaultSortingField?: string;
27
27
  metadata?: Record<string, unknown>;
28
28
  }
29
+ enum SearchPrioritizeType {
30
+ TokenPosition = "token_position",
31
+ ExactMatch = "exact_match",
32
+ NumMatchingFields = "num_matching_fields"
33
+ }
29
34
  interface SearchQuery {
30
35
  query: string;
31
36
  by?: string;
@@ -33,6 +38,7 @@ export declare namespace BrostarkSolutions {
33
38
  filterBy?: string;
34
39
  page?: number;
35
40
  limit?: number;
41
+ prioritize?: SearchPrioritizeType[];
36
42
  }
37
43
  interface SearchResult {
38
44
  page: number;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,MAAM,CAAC;QACtB,KAAY,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,GAAG,YAAY,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;QACtO,UAAiB,eAAe;YAC9B,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,SAAS,CAAC;YAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;SACtB;QAED,UAAiB,sBAAsB;YACrC,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE,eAAe,EAAE,CAAC;YAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACpC;QAED,UAAiB,WAAW;YAC1B,KAAK,EAAE,MAAM,CAAC;YACd,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,YAAY;YAC3B,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;YACf,cAAc,EAAE,MAAM,CAAC;YACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;SACjC;QAED,KAAY,QAAQ,GAAG;YACrB,EAAE,EAAE,MAAM,CAAC;SACZ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC7B;CACF"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,MAAM,CAAC;QACtB,KAAY,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,GAAG,YAAY,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;QACtO,UAAiB,eAAe;YAC9B,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,SAAS,CAAC;YAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;SACtB;QAED,UAAiB,sBAAsB;YACrC,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE,eAAe,EAAE,CAAC;YAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACpC;QAED,KAAY,oBAAoB;YAC9B,aAAa,mBAAmB;YAChC,UAAU,gBAAgB;YAC1B,iBAAiB,wBAAwB;SAC1C;QAED,UAAiB,WAAW;YAC1B,KAAK,EAAE,MAAM,CAAC;YACd,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;SACrC;QAED,UAAiB,YAAY;YAC3B,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;YACf,cAAc,EAAE,MAAM,CAAC;YACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;SACjC;QAED,KAAY,QAAQ,GAAG;YACrB,EAAE,EAAE,MAAM,CAAC;SACZ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC7B;CACF"}
package/dist/lib/types.js CHANGED
@@ -1,2 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BrostarkSolutions = void 0;
4
+ var BrostarkSolutions;
5
+ (function (BrostarkSolutions) {
6
+ let Search;
7
+ (function (Search) {
8
+ let SearchPrioritizeType;
9
+ (function (SearchPrioritizeType) {
10
+ SearchPrioritizeType["TokenPosition"] = "token_position";
11
+ SearchPrioritizeType["ExactMatch"] = "exact_match";
12
+ SearchPrioritizeType["NumMatchingFields"] = "num_matching_fields";
13
+ })(SearchPrioritizeType = Search.SearchPrioritizeType || (Search.SearchPrioritizeType = {}));
14
+ })(Search = BrostarkSolutions.Search || (BrostarkSolutions.Search = {}));
15
+ })(BrostarkSolutions || (exports.BrostarkSolutions = BrostarkSolutions = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@brostark/solutions-client",
3
- "version": "1.1.16",
3
+ "version": "1.1.18",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "scripts": {
@@ -0,0 +1,23 @@
1
+ import { httpUploadRequest } from "../../lib/httpRequest";
2
+
3
+
4
+ /**
5
+ * Generates an API to manage media
6
+ * @param apiUrl - The API URL
7
+ * @param apiKey - The API key for authentication
8
+ * @returns An object containing methods to interact with the media API
9
+ */
10
+ export const generateMediaAPI = (apiUrl: string, apiKey: string) => {
11
+ return {
12
+ /**
13
+ * Uploads a new video
14
+ * @param file - The video file to upload
15
+ * @returns A promise with information about the uploaded video (URL and path)
16
+ */
17
+ upload: async (file: File, filename: string) => {
18
+ const response = await httpUploadRequest(`${apiUrl}/media/${filename}`, apiKey, file);
19
+
20
+ return response.data;
21
+ },
22
+ }
23
+ }
@@ -101,7 +101,9 @@ export const generateSearchAPI = (apiUrl: string, apiKey: string) => {
101
101
  const urlQuery: Record<string, string> = {}
102
102
 
103
103
  Object.entries(query).forEach(([key, value]) => {
104
- if (value !== undefined && value !== null) {
104
+ if (Array.isArray(value)) {
105
+ urlQuery[key] = value.join(",");
106
+ } else if (value !== undefined && value !== null) {
105
107
  urlQuery[key] = String(value);
106
108
  }
107
109
  });
package/src/client.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { generateLiveAPI } from "./api/v1/live";
2
+ import { generateMediaAPI } from "./api/v1/media";
2
3
  import { generateSearchAPI } from "./api/v1/search";
3
4
  import { generateVideoAPI } from "./api/v1/video";
4
5
  import { ApiVersion, DEFAULT_API_HOST, DEFAULT_API_VERSION } from "./constant";
@@ -16,6 +17,7 @@ export interface CreateClientOptions {
16
17
  export interface BrostarkSolutionsClient {
17
18
  live: ReturnType<typeof generateLiveAPI>;
18
19
  video: ReturnType<typeof generateVideoAPI>;
20
+ media: ReturnType<typeof generateMediaAPI>;
19
21
  search: ReturnType<typeof generateSearchAPI>;
20
22
  }
21
23
 
@@ -35,6 +37,7 @@ export function createClient(apiKey: string, options: CreateClientOptions = {}):
35
37
 
36
38
  return {
37
39
  live: generateLiveAPI(apiUrl, apiKey),
40
+ media: generateMediaAPI(apiUrl, apiKey),
38
41
  video: generateVideoAPI(apiUrl, apiKey),
39
42
  search: generateSearchAPI(apiUrl, apiKey),
40
43
  }
package/src/lib/types.ts CHANGED
@@ -30,6 +30,12 @@ export namespace BrostarkSolutions {
30
30
  metadata?: Record<string, unknown>;
31
31
  }
32
32
 
33
+ export enum SearchPrioritizeType {
34
+ TokenPosition = "token_position",
35
+ ExactMatch = "exact_match",
36
+ NumMatchingFields = "num_matching_fields",
37
+ }
38
+
33
39
  export interface SearchQuery {
34
40
  query: string;
35
41
  by?: string;
@@ -37,6 +43,7 @@ export namespace BrostarkSolutions {
37
43
  filterBy?: string;
38
44
  page?: number;
39
45
  limit?: number;
46
+ prioritize?: SearchPrioritizeType[];
40
47
  }
41
48
 
42
49
  export interface SearchResult {