@narrative.io/data-collaboration-sdk-ts 0.0.24 → 0.0.25

package/build/mappings/index.d.ts

@@ -0,0 +1,11 @@
+import { type ApiRecords } from 'src/types';
+import { BaseApi } from '../base-api';
+import { type Mapping } from './types';
+/**
+ * A class for accessing the Mappings API.
+ * @extends BaseApi
+ */
+declare class MappingsApi extends BaseApi {
+    getMappings(): Promise<ApiRecords<Mapping>>;
+}
+export { type Mapping, MappingsApi };

package/build/mappings/index.js

@@ -0,0 +1,18 @@
+import { BaseApi } from '../base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = 'mappings';
+/**
+ * A class for accessing the Mappings API.
+ * @extends BaseApi
+ */
+class MappingsApi extends BaseApi {
+    async getMappings() {
+        return await this.get(resourceName);
+    }
+}
+export { MappingsApi };

package/build/mappings/types.d.ts

@@ -0,0 +1,31 @@
+export interface Mapping {
+    id: string;
+    attribute_id: number;
+    created_at: string;
+    dataset_id: number;
+    mapping: ObjectMapping | ValueMapping;
+    status: MappingStatus;
+    updated_at: string;
+    created_by: number;
+    updated_by: number;
+    company_id: number;
+    scope: MappingScope;
+    source: MappingSource;
+    derived_from: string;
+}
+type MappingStatus = 'active' | 'archived' | 'pending';
+type MappingScope = 'global' | 'private';
+type MappingSource = 'system' | 'admin' | 'company';
+interface PropertyMapping {
+    path: string;
+    expression: string;
+}
+interface ObjectMapping {
+    type: 'object_mapping';
+    property_mappings: PropertyMapping[];
+}
+interface ValueMapping {
+    type: 'value_mapping';
+    expression: string;
+}
+export {};

package/build/mappings/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

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