@narrative.io/data-collaboration-sdk-ts 0.9.0 → 0.10.1

package/build/access-rules/index.d.ts

@@ -1,12 +1,13 @@
-import type { ApiRecords, ApiRecordsV2 } from "../types";
+import type { ApiRecords, ApiRecordsV2, PaginationOptions } from "../types";
 import { BaseApi } from "../base-api";
 import type { AccessRule, AccessRuleV2 } from "./types";
 /**
  * Represents the parameters used to retrieve access rules.
- * This interface extends a generic record allowing for string, number, boolean, or undefined values.
+ * This interface extends a generic record allowing for a range of value types including arrays.
+ * It's primarily used to filter access rules.
  *
  * @interface GetAccessRulesParameters
- * @extends {Record<string, string | number | boolean | undefined>}
+ * @extends {Record<string, string | number | boolean | undefined | string[] | number[]>}
  *
  * @property {boolean} [owned_only] - Optional filter to retrieve only the access rules owned by the user.
  *                                    Setting this to true will fetch only the access rules that are owned.
@@ -14,23 +15,21 @@ import type { AccessRule, AccessRuleV2 } from "./types";
  * @property {boolean} [shared_only] - Optional filter to retrieve only the access rules shared with the user.
  *                                     Setting this to true will fetch only the access rules that are shared.
  *
- * @property {string} [tag] - Optional filter to retrieve access rules that are tagged with a specific tag.
- *                           Provide the tag string to fetch access rules associated with it.
+ * @property {string | string[]} [tag] - Optional filter to retrieve access rules tagged with a specific tag or tags.
+ *                                       Provide a single tag or an array of tags to fetch access rules associated with them.
  *
- * @property {number} [company_id] - Optional filter to retrieve access rules associated with a specific company.
- *                                   Provide the company ID to fetch access rules related to that company.
+ * @property {number | number[]} [company_id] - Optional filter to retrieve access rules associated with a specific company or companies.
+ *                                              Provide a company ID or an array of IDs to fetch access rules related to those companies.
  *
- * @property {number} [offset] - Optional pagination parameter that specifies the starting point for the list of results.
- *                               Provide an offset number to skip a specific number of records in the result set.
- *
- * @property {number} [per_page] - Optional pagination parameter that specifies the number of records to return per page.
- *                                 Provide a number to set the maximum number of records returned in one page of results.
+ * @property {number | number[]} [dataset_id] - Optional filter to retrieve access rules associated with a specific dataset or datasets.
+ *                                              Provide a dataset ID or an array of IDs to fetch access rules related to those datasets.
  */
-interface GetAccessRulesParameters extends Record<string, string | number | boolean | undefined> {
+interface GetAccessRulesParameters extends Record<string, string | number | boolean | undefined | string[] | number[]> {
     owned_only?: boolean;
     shared_only?: boolean;
-    tag?: string;
-    company_id?: number;
+    tag?: string | string[];
+    company_id?: number | number[];
+    dataset_id?: number | number[];
 }
 /**
  * @module AccessRulesApi
@@ -105,6 +104,6 @@ declare class AccessRulesApi extends BaseApi {
      * @description This method fetches access rules based on the specified filters and pagination options provided in the parameters.
      *              It returns a promise that resolves to a list of access rules that match the criteria.
      */
-    getAccessableAccessRules(parameters: GetAccessRulesParameters): Promise<ApiRecordsV2<AccessRuleV2>>;
+    getAccessableAccessRules(parameters: GetAccessRulesParameters & PaginationOptions): Promise<ApiRecordsV2<AccessRuleV2>>;
 }
 export { AccessRulesApi, type AccessRule, type AccessRuleV2, type GetAccessRulesParameters, };

package/build/access-rules/types.d.ts

@@ -9,6 +9,10 @@ export interface AccessRule {
     pricing: AccessRulePricing;
     status: "active";
     updated_at: string;
+    query?: string;
+    display_name?: string;
+    image?: string;
+    tags?: string[];
 }
 type AccessRuleDatasetId = number;
 interface AccessRulePolicyDataset {

package/build/base-api.js

@@ -157,9 +157,14 @@ export class BaseApi {
         const queryParameters = [];
         if (parameters != null) {
             for (const [key, value] of Object.entries(parameters)) {
-                if (value !== undefined && value !== null) {
+                if (value !== undefined && value !== null && !Array.isArray(value)) {
                     queryParameters.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`);
                 }
+                if (Array.isArray(value)) {
+                    for (const val of value) {
+                        queryParameters.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(val))}`);
+                    }
+                }
             }
         }
         return queryParameters.length > 0 ? `?${queryParameters.join("&")}` : "";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.9.0",
+  "version": "0.10.1",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",