@brostark/solutions-client 1.1.9 → 1.1.11

package/dist/api/v1/search.d.ts

@@ -38,6 +38,13 @@ export declare const generateSearchAPI: (apiUrl: string, apiKey: string) => {
      * @returns A promise with the deleted document
      */
     deleteDocument: (collectionName: string, documentId: string) => Promise<any>;
+    /**
+     * Gets a document from a search collection by its ID
+     * @param collectionName - The name of the collection to get the document from
+     * @param documentId - The ID of the document to get
+     * @returns A promise with the document
+     */
+    getDocumentById: (collectionName: string, documentId: string) => Promise<any>;
     /**
      * Searches for documents in a search collection
      * @param collectionName - The name of the collection to search in

package/dist/api/v1/search.d.ts.map

@@ -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;AAIjE;;;;;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;4BAC2B,MAAM,SAAS,iBAAiB,CAAC,MAAM,CAAC,WAAW,KAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC;CAcrI,CAAA"}
+{"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;AAIjE;;;;;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;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"}

package/dist/api/v1/search.js

@@ -57,6 +57,16 @@ const generateSearchAPI = (apiUrl, apiKey) => {
             const response = await (0, httpRequest_1.httpDeleteRequest)(`${apiUrl}/search/collections/${collectionName}/documents/${documentId}`, apiKey);
             return response.data;
         },
+        /**
+         * Gets a document from a search collection by its ID
+         * @param collectionName - The name of the collection to get the document from
+         * @param documentId - The ID of the document to get
+         * @returns A promise with the document
+         */
+        getDocumentById: async (collectionName, documentId) => {
+            const response = await (0, httpRequest_1.httpGetRequest)(`${apiUrl}/search/collections/${collectionName}/documents/${documentId}`, apiKey);
+            return response.data;
+        },
         /**
          * Searches for documents in a search collection
          * @param collectionName - The name of the collection to search in

package/dist/client.d.ts

@@ -1,3 +1,6 @@
+import { generateLiveAPI } from "./api/v1/live";
+import { generateSearchAPI } from "./api/v1/search";
+import { generateVideoAPI } from "./api/v1/video";
 import { ApiVersion } from "./constant";
 /**
  * Options for creating the client
@@ -8,31 +11,16 @@ export interface CreateClientOptions {
     /** The API version (default: DEFAULT_API_VERSION) */
     version?: ApiVersion;
 }
+export interface BrostarkSolutionsClient {
+    live: ReturnType<typeof generateLiveAPI>;
+    video: ReturnType<typeof generateVideoAPI>;
+    search: ReturnType<typeof generateSearchAPI>;
+}
 /**
  * Creates an instance of the API client
  * @param apiKey - The API key for authentication
  * @param options - The configuration options for the client
  * @returns An object containing the different APIs available
  */
-export declare function createClient(apiKey: string, options?: CreateClientOptions): {
-    live: {
-        createLive: () => Promise<any>;
-        getActiveLive: () => Promise<any>;
-    };
-    video: {
-        list: (options?: import("./lib/types").ListOptions) => Promise<any>;
-        upload: (file: File) => Promise<any>;
-        get: (id: string) => Promise<any>;
-        stream: (filename: string) => Promise<string>;
-        remove: (id: string) => Promise<any>;
-    };
-    search: {
-        listCollections: (options?: import("./lib/types").ListOptions) => Promise<any>;
-        createCollection: (params: import("./lib/types").BrostarkSolutions.Search.CreateCollectionParams) => Promise<any>;
-        deleteCollection: (name: string) => Promise<any>;
-        upsertDocuments: (collectionName: string, documents: Record<string, unknown>[]) => Promise<any>;
-        deleteDocument: (collectionName: string, documentId: string) => Promise<any>;
-        query: (collectionName: string, query: import("./lib/types").BrostarkSolutions.Search.SearchQuery) => Promise<import("./lib/types").BrostarkSolutions.Search.SearchResult>;
-    };
-};
+export declare function createClient(apiKey: string, options?: CreateClientOptions): BrostarkSolutionsClient;
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,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;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;;;;;;;;;;;;;;;;;;;;EAa7E"}
+{"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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brostark/solutions-client",
-  "version": "1.1.9",
+  "version": "1.1.11",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/api/v1/search.ts

@@ -66,6 +66,18 @@ export const generateSearchAPI = (apiUrl: string, apiKey: string) => {
       return response.data;
     },
 
+    /**
+     * Gets a document from a search collection by its ID
+     * @param collectionName - The name of the collection to get the document from
+     * @param documentId - The ID of the document to get
+     * @returns A promise with the document
+     */
+    getDocumentById: async (collectionName: string, documentId: string) => {
+      const response = await httpGetRequest(`${apiUrl}/search/collections/${collectionName}/documents/${documentId}`, apiKey);
+
+      return response.data;
+    },
+
     /**
      * Searches for documents in a search collection
      * @param collectionName - The name of the collection to search in

package/src/client.ts

@@ -13,13 +13,19 @@ export interface CreateClientOptions {
   version?: ApiVersion;
 }
 
+export interface BrostarkSolutionsClient {
+  live: ReturnType<typeof generateLiveAPI>;
+  video: ReturnType<typeof generateVideoAPI>;
+  search: ReturnType<typeof generateSearchAPI>;
+}
+
 /**
  * Creates an instance of the API client
  * @param apiKey - The API key for authentication
  * @param options - The configuration options for the client
  * @returns An object containing the different APIs available
  */
-export function createClient(apiKey: string, options: CreateClientOptions = {}) {
+export function createClient(apiKey: string, options: CreateClientOptions = {}): BrostarkSolutionsClient {
   const {
     host = DEFAULT_API_HOST,
     version = DEFAULT_API_VERSION,