@mappa-ai/mappa-node 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Plus Five Five, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# Mappa Node SDK
+
+A lightweight JavaScript/TypeScript client for the Mappa API.
+
+## Installation
+
+```bash
+npm install mappa-node
+# or
+yarn add mappa-node
+# or
+pnpm install mappa-node
+# or
+bun add mappa-node
+```
+
+## Requirements
+
+- A valid Mappa API key.
+
+## Authentication
+
+Set the `MAPPA_API_KEY` environment variable or pass the key directly:
+
+```bash
+export MAPPA_API_KEY="your-api-key"
+```
+
+```ts
+import { Mappa } from "mappa-node";
+
+const client = new Mappa("your-api-key");
+```
+
+## Usage
+
+### Instantiate the client
+
+```ts
+import { Mappa } from "mappa-node";
+
+const mappa = new Mappa(); // Reads MAPPA_API_KEY by default
+```
+
+### Generate a behavior profile from a remote URL
+
+```ts
+await mappa.generateTextReport({
+  inputMedia: {
+    kind: "url",
+    url: "https://example.com/media.mp3",
+  },
+  targetSpeaker: { strategy: "dominant" },
+});
+```
+
+### Generate a behavior profile from an uploaded file
+
+```ts
+const file = new File([buffer], "sample.wav", { type: "audio/wav" });
+
+await mappa.generateTextReport({
+  inputMedia: {
+    kind: "file",
+    file,
+  },
+  targetSpeaker: {
+    strategy: "magic_hint",
+    hint: "the person being interviewed",
+  },
+});
+```
+
+The method returns:
+
+```ts
+{
+  behaviorProfile: string;
+  entityId: string;
+}
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1 @@
+let e=require(`zod`);var t=class{async generateReport(){return``}};async function n(e,t=3){let n;for(let r=0;r<t;r++)try{return await e()}catch(e){console.warn(`Attempt ${r+1} failed. Retrying...`),n=e}throw n}let r;(function(t){t.availablePresetsSchema=e.z.enum([`base`])})(r||={});let i;(function(t){t.generateReportInputSchema=e.z.object({inputMedia:e.z.discriminatedUnion(`kind`,[e.z.object({kind:e.z.literal(`file`),file:e.z.file().mime([`video/*`,`audio/*`],{message:`Invalid file type, only audio and video files are allowed`}).describe(`The audio file to be processed`)}),e.z.object({kind:e.z.literal(`url`),url:e.z.url().describe(`The URL of the audio or video file to be processed`)})]),targetSpeaker:e.z.discriminatedUnion(`strategy`,[e.z.object({strategy:e.z.literal(`dominant`).describe(`Select the speaker who speaks the most in the audio`)}),e.z.object({strategy:e.z.literal(`magic_hint`).describe(`Use a hint to identify the target speaker`),hint:e.z.string().describe(`A hint to help identify the target speaker, e.g., 'the interviewer', 'the CEO', 'the person being interviewed`)})]).default({strategy:`dominant`}).describe(`Strategy for target extraction, this is useful when there are multiple speakers in the audio`),template:r.availablePresetsSchema}),t.generateReportOutputSchema=e.z.object({outputs:e.z.object({entity_id:e.z.string().describe(`The unique identifier for the analyzed entity`),behavior_profile:e.z.string().describe(`The generated behavior profile report`)}).array().transform(e=>e[0]??null)})})(i||={});var a=class{apiKey;apiBaseUrl=`https://api.mappa.ai`;apiVersion=`v1`;presets=new t;constructor(e){if(!e&&typeof process<`u`&&process.env&&process.env.MAPPA_API_KEY?.trim()!==``&&(this.apiKey=process.env.MAPPA_API_KEY||``),this.apiKey=e||``,this.apiKey.trim()===``)throw Error(`Mappa API key is required`)}async generateTextReport(e){let t;if(e.inputMedia.kind===`file`){let r=new FormData;r.append(`file`,e.inputMedia.file),r.append(`metadata`,JSON.stringify({mode:`sync`,output:`behavior_profile`,target:e.targetSpeaker})),t=await n(()=>fetch(`${this.apiBaseUrl}/${this.apiVersion}/analyze/file`,{method:`POST`,headers:{"Mappa-Api-Key":this.apiKey},body:r}))}else{let r=new URL(e.inputMedia.url);t=await n(()=>fetch(`${this.apiBaseUrl}/${this.apiVersion}/analyze/url`,{method:`POST`,headers:{"Content-Type":`application/json`,"Mappa-Api-Key":this.apiKey},body:JSON.stringify({url:r.href,mode:`sync`,output:`behavior_profile`,target:e.targetSpeaker})}))}if(!t.ok){let e=`Mappa API request failed with status ${t.status}: ${await t.text().catch(()=>`Unable to retrieve error message`)}`;throw console.error(e),Error(e)}let r=await t.json(),a=i.generateReportOutputSchema.parse(r).outputs;if(!a)throw Error(`No outputs found in the response, error occurred during analysis.`);return{behaviorProfile:a.behavior_profile,entityId:a.entity_id}}};exports.Mappa=a;

package/dist/index.d.cts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+
+//#region src/presets.d.ts
+declare class Presets {
+  generateReport(): Promise<string>;
+}
+//#endregion
+//#region src/mappa/model.d.ts
+declare namespace MappaModel {
+  const generateReportInputSchema: z.ZodObject<{
+    inputMedia: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      kind: z.ZodLiteral<"file">;
+      file: z.ZodFile;
+    }, z.core.$strip>, z.ZodObject<{
+      kind: z.ZodLiteral<"url">;
+      url: z.ZodURL;
+    }, z.core.$strip>], "kind">;
+    targetSpeaker: z.ZodDefault<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      strategy: z.ZodLiteral<"dominant">;
+    }, z.core.$strip>, z.ZodObject<{
+      strategy: z.ZodLiteral<"magic_hint">;
+      hint: z.ZodString;
+    }, z.core.$strip>], "strategy">>;
+    template: z.ZodEnum<{
+      base: "base";
+    }>;
+  }, z.core.$strip>;
+  type GenerateReportInput = z.infer<typeof generateReportInputSchema>;
+  const generateReportOutputSchema: z.ZodObject<{
+    outputs: z.ZodPipe<z.ZodArray<z.ZodObject<{
+      entity_id: z.ZodString;
+      behavior_profile: z.ZodString;
+    }, z.core.$strip>>, z.ZodTransform<{
+      entity_id: string;
+      behavior_profile: string;
+    } | null, {
+      entity_id: string;
+      behavior_profile: string;
+    }[]>>;
+  }, z.core.$strip>;
+  type GenerateReportOutput = z.infer<typeof generateReportOutputSchema>;
+}
+//#endregion
+//#region src/mappa/index.d.ts
+/**
+ * Client for the Mappa API that provides access to presets and can generate a synchronous behavior profile report
+ * from either an uploaded media file or a remote media URL.
+ */
+declare class Mappa {
+  private readonly apiKey;
+  private readonly apiBaseUrl;
+  private readonly apiVersion;
+  readonly presets: Presets;
+  /**
+   * Initializes the client with an API key sourced from arguments or the environment.
+   */
+  constructor(apiKey?: string);
+  /**
+   * Generates a synchronous behavior profile report from either an uploaded media file or a remote media URL.
+   */
+  generateTextReport(body: MappaModel.GenerateReportInput): Promise<{
+    behaviorProfile: string;
+    entityId: string;
+  }>;
+}
+//#endregion
+export { Mappa };

package/dist/index.d.mts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+
+//#region src/presets.d.ts
+declare class Presets {
+  generateReport(): Promise<string>;
+}
+//#endregion
+//#region src/mappa/model.d.ts
+declare namespace MappaModel {
+  const generateReportInputSchema: z.ZodObject<{
+    inputMedia: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      kind: z.ZodLiteral<"file">;
+      file: z.ZodFile;
+    }, z.core.$strip>, z.ZodObject<{
+      kind: z.ZodLiteral<"url">;
+      url: z.ZodURL;
+    }, z.core.$strip>], "kind">;
+    targetSpeaker: z.ZodDefault<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      strategy: z.ZodLiteral<"dominant">;
+    }, z.core.$strip>, z.ZodObject<{
+      strategy: z.ZodLiteral<"magic_hint">;
+      hint: z.ZodString;
+    }, z.core.$strip>], "strategy">>;
+    template: z.ZodEnum<{
+      base: "base";
+    }>;
+  }, z.core.$strip>;
+  type GenerateReportInput = z.infer<typeof generateReportInputSchema>;
+  const generateReportOutputSchema: z.ZodObject<{
+    outputs: z.ZodPipe<z.ZodArray<z.ZodObject<{
+      entity_id: z.ZodString;
+      behavior_profile: z.ZodString;
+    }, z.core.$strip>>, z.ZodTransform<{
+      entity_id: string;
+      behavior_profile: string;
+    } | null, {
+      entity_id: string;
+      behavior_profile: string;
+    }[]>>;
+  }, z.core.$strip>;
+  type GenerateReportOutput = z.infer<typeof generateReportOutputSchema>;
+}
+//#endregion
+//#region src/mappa/index.d.ts
+/**
+ * Client for the Mappa API that provides access to presets and can generate a synchronous behavior profile report
+ * from either an uploaded media file or a remote media URL.
+ */
+declare class Mappa {
+  private readonly apiKey;
+  private readonly apiBaseUrl;
+  private readonly apiVersion;
+  readonly presets: Presets;
+  /**
+   * Initializes the client with an API key sourced from arguments or the environment.
+   */
+  constructor(apiKey?: string);
+  /**
+   * Generates a synchronous behavior profile report from either an uploaded media file or a remote media URL.
+   */
+  generateTextReport(body: MappaModel.GenerateReportInput): Promise<{
+    behaviorProfile: string;
+    entityId: string;
+  }>;
+}
+//#endregion
+export { Mappa };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{z as e}from"zod";var t=class{async generateReport(){return``}};async function n(e,t=3){let n;for(let r=0;r<t;r++)try{return await e()}catch(e){console.warn(`Attempt ${r+1} failed. Retrying...`),n=e}throw n}let r;(function(t){t.availablePresetsSchema=e.enum([`base`])})(r||={});let i;(function(t){t.generateReportInputSchema=e.object({inputMedia:e.discriminatedUnion(`kind`,[e.object({kind:e.literal(`file`),file:e.file().mime([`video/*`,`audio/*`],{message:`Invalid file type, only audio and video files are allowed`}).describe(`The audio file to be processed`)}),e.object({kind:e.literal(`url`),url:e.url().describe(`The URL of the audio or video file to be processed`)})]),targetSpeaker:e.discriminatedUnion(`strategy`,[e.object({strategy:e.literal(`dominant`).describe(`Select the speaker who speaks the most in the audio`)}),e.object({strategy:e.literal(`magic_hint`).describe(`Use a hint to identify the target speaker`),hint:e.string().describe(`A hint to help identify the target speaker, e.g., 'the interviewer', 'the CEO', 'the person being interviewed`)})]).default({strategy:`dominant`}).describe(`Strategy for target extraction, this is useful when there are multiple speakers in the audio`),template:r.availablePresetsSchema}),t.generateReportOutputSchema=e.object({outputs:e.object({entity_id:e.string().describe(`The unique identifier for the analyzed entity`),behavior_profile:e.string().describe(`The generated behavior profile report`)}).array().transform(e=>e[0]??null)})})(i||={});var a=class{apiKey;apiBaseUrl=`https://api.mappa.ai`;apiVersion=`v1`;presets=new t;constructor(e){if(!e&&typeof process<`u`&&process.env&&process.env.MAPPA_API_KEY?.trim()!==``&&(this.apiKey=process.env.MAPPA_API_KEY||``),this.apiKey=e||``,this.apiKey.trim()===``)throw Error(`Mappa API key is required`)}async generateTextReport(e){let t;if(e.inputMedia.kind===`file`){let r=new FormData;r.append(`file`,e.inputMedia.file),r.append(`metadata`,JSON.stringify({mode:`sync`,output:`behavior_profile`,target:e.targetSpeaker})),t=await n(()=>fetch(`${this.apiBaseUrl}/${this.apiVersion}/analyze/file`,{method:`POST`,headers:{"Mappa-Api-Key":this.apiKey},body:r}))}else{let r=new URL(e.inputMedia.url);t=await n(()=>fetch(`${this.apiBaseUrl}/${this.apiVersion}/analyze/url`,{method:`POST`,headers:{"Content-Type":`application/json`,"Mappa-Api-Key":this.apiKey},body:JSON.stringify({url:r.href,mode:`sync`,output:`behavior_profile`,target:e.targetSpeaker})}))}if(!t.ok){let e=`Mappa API request failed with status ${t.status}: ${await t.text().catch(()=>`Unable to retrieve error message`)}`;throw console.error(e),Error(e)}let r=await t.json(),a=i.generateReportOutputSchema.parse(r).outputs;if(!a)throw Error(`No outputs found in the response, error occurred during analysis.`);return{behaviorProfile:a.behavior_profile,entityId:a.entity_id}}};export{a as Mappa};

package/package.json

@@ -0,0 +1,44 @@
+{
+	"name": "@mappa-ai/mappa-node",
+	"module": "src/index.ts",
+	"type": "module",
+	"version": "0.1.0",
+	"license": "MIT",
+	"private": false,
+	"files": [
+		"dist/**"
+	],
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/index.d.mts",
+				"default": "./dist/index.mjs"
+			},
+			"require": {
+				"types": "./dist/index.d.cts",
+				"default": "./dist/index.cjs"
+			}
+		}
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/mappa-ai/mappa-node.git"
+	},
+	"scripts": {
+		"build": "tsdown",
+		"typecheck": "tsc --noEmit",
+		"test": "bun test",
+		"check": "biome check",
+		"check:fix": "biome check --fix",
+		"lazycheck": "bun run check && bun run typecheck"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^2.3.11",
+		"@types/bun": "latest",
+		"tsdown": "^0.19.0",
+		"typescript": "^5.9.3"
+	},
+	"dependencies": {
+		"zod": "^4.3.5"
+	}
+}