@motif-ai/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2025 Motif, Inc. All rights reserved.
+
+This software is provided under the Motif SDK License Agreement.
+
+Permission is hereby granted to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to use
+the Software solely for the purpose of integrating with the Motif API
+in accordance with the Motif Terms of Service.
+
+The following restrictions apply:
+
+1. You may not modify, merge, publish, distribute, sublicense, or sell
+   copies of the Software.
+
+2. You may not reverse engineer, decompile, or disassemble the Software.
+
+3. You may not use the Software for any purpose other than integrating
+   with the Motif API.
+
+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,127 @@
+# @motif-ai/sdk
+
+Official TypeScript SDK for the Motif API. Manage users, investor profiling questionnaires, and personalized investment strategies.
+
+## Install
+
+```bash
+npm install @motif-ai/sdk
+```
+
+## Quick Start
+
+```typescript
+import { createClient } from '@motif-ai/sdk'
+
+const client = createClient({
+  apiKey: process.env.MOTIF_API_KEY!,
+})
+
+// Create a user
+const user = await client.users.create({
+  email: 'jane@example.com',
+  name: 'Jane Doe',
+  externalId: 'your_internal_id_123',
+})
+
+// List users
+const { data: users } = await client.users.list({ limit: 10 })
+```
+
+## User-Scoped Operations
+
+Operations like profiling and strategy recommendations are scoped to a specific user:
+
+```typescript
+const userClient = client.forUser(user.id)
+
+// Get profiling questions
+const questions = await userClient.profile.getQuestions({ type: 'Basic' })
+
+// Save an answer
+await userClient.profile.saveAnswer({
+  questionId: questions[0].id,
+  answer: 'Growth',
+})
+
+// Compute investor profile from answers
+const profile = await userClient.profile.computeInvestorProfile()
+
+// Get recommended investment strategy
+const strategy = await userClient.strategies.getRecommended()
+```
+
+## Configuration
+
+```typescript
+const client = createClient({
+  apiKey: 'pk_live_...', // Required
+  baseURL: 'https://api.motifapp.ai/api', // Optional (default)
+  timeout: 30000, // Optional, ms (default: 30000)
+  headers: { 'x-custom': 'value' }, // Optional extra headers
+})
+```
+
+## API Reference
+
+### `createClient(config)`
+
+Returns a client with the following namespaces:
+
+#### `client.users`
+
+| Method                        | Description                |
+| ----------------------------- | -------------------------- |
+| `create(data)`                | Create a new user          |
+| `list(params?)`               | List users with pagination |
+| `get(id)`                     | Get user by ID             |
+| `update(id, data)`            | Update user                |
+| `delete(id)`                  | Delete user                |
+| `getByExternalId(externalId)` | Get user by external ID    |
+
+#### `client.forUser(userId)`
+
+Returns a user-scoped client with:
+
+**`profile`**
+
+| Method                          | Description                     |
+| ------------------------------- | ------------------------------- |
+| `getQuestions(params)`          | Get profiling questions by tier |
+| `saveAnswer(data)`              | Save a profiling answer         |
+| `getAnswers()`                  | Get all answers                 |
+| `getInvestorProfile()`          | Get computed investor profile   |
+| `computeInvestorProfile(data?)` | Compute/refresh profile         |
+| `getCompletion(params)`         | Check profiling completion      |
+
+**`strategies`**
+
+| Method             | Description                  |
+| ------------------ | ---------------------------- |
+| `getRecommended()` | Get recommended strategy     |
+| `generate(data?)`  | Generate AI-powered strategy |
+
+## Error Handling
+
+```typescript
+import { createClient, MotifSDKError } from '@motif-ai/sdk'
+
+try {
+  const user = await client.users.get('invalid_id')
+} catch (error) {
+  if (error instanceof MotifSDKError) {
+    console.error(error.message) // Human-readable message
+    console.error(error.statusCode) // HTTP status (e.g. 404)
+    console.error(error.response) // Raw response body
+  }
+}
+```
+
+## Requirements
+
+- Node.js >= 18
+- TypeScript >= 5.0 (optional, for type checking)
+
+## License
+
+Proprietary — see [LICENSE](./LICENSE). Use is permitted solely for integrating with the Motif API.

package/dist/index.cjs

@@ -0,0 +1,501 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AdminApiKeysCreateBodyEnvironment: () => AdminApiKeysCreateBodyEnvironment,
+  AdminConfigUpdateInvestmentConfigBodyConfigDexRouteOrder: () => AdminConfigUpdateInvestmentConfigBodyConfigDexRouteOrder,
+  AdminConfigUpdateInvestmentConfigBodyConfigDexRouteSelectionHierarchyItem: () => AdminConfigUpdateInvestmentConfigBodyConfigDexRouteSelectionHierarchyItem,
+  AdminConfigUpdateTransactionConfigBodyConfigRouteSelectionHierarchyItem: () => AdminConfigUpdateTransactionConfigBodyConfigRouteSelectionHierarchyItem,
+  AdminOrganizationInviteOrgAdminBodyRole: () => AdminOrganizationInviteOrgAdminBodyRole,
+  AdminUserUpdateMemberRoleBodyRole: () => AdminUserUpdateMemberRoleBodyRole,
+  MarketDataGetLatestMarketDataProvider: () => MarketDataGetLatestMarketDataProvider,
+  MarketDataGetLatestMarketDataResolution: () => MarketDataGetLatestMarketDataResolution,
+  MotifSDKError: () => MotifSDKError,
+  SdkProfileGetAnswers200ItemTier: () => SdkProfileGetAnswers200ItemTier,
+  SdkProfileGetCompletionTier: () => SdkProfileGetCompletionTier,
+  SdkProfileGetQuestions200ItemAction: () => SdkProfileGetQuestions200ItemAction,
+  SdkProfileGetQuestions200ItemType: () => SdkProfileGetQuestions200ItemType,
+  SdkProfileGetQuestionsType: () => SdkProfileGetQuestionsType,
+  createClient: () => createClient
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/axios-instance.ts
+var import_axios = __toESM(require("axios"), 1);
+var MotifSDKError = class extends Error {
+  constructor(message, statusCode, response) {
+    super(message);
+    this.statusCode = statusCode;
+    this.response = response;
+    this.name = "MotifSDKError";
+  }
+};
+var config = null;
+var configure = (options) => {
+  if (!options.apiKey) {
+    throw new Error("API key is required");
+  }
+  config = {
+    ...options,
+    baseURL: options.baseURL || "https://api.motifapp.ai/api",
+    timeout: options.timeout || 3e4
+  };
+};
+var customInstance = async (requestConfig) => {
+  if (!config) {
+    throw new MotifSDKError(
+      "Motif SDK not configured. Call configure() first with your API key."
+    );
+  }
+  const baseURL = config.baseURL;
+  let origin;
+  let basePath;
+  try {
+    const parsed = new URL(baseURL);
+    origin = parsed.origin;
+    basePath = parsed.pathname.replace(/\/+$/, "");
+  } catch {
+    origin = "";
+    basePath = baseURL.replace(/\/+$/, "");
+  }
+  if (basePath && requestConfig.url) {
+    requestConfig.url = `${basePath}${requestConfig.url}`;
+  }
+  const instance = import_axios.default.create({
+    baseURL: origin || void 0,
+    timeout: config.timeout,
+    headers: {
+      "Content-Type": "application/json",
+      "x-api-key": config.apiKey,
+      ...config.headers
+    }
+  });
+  instance.interceptors.request.use(
+    (request) => {
+      const isJsonContentType = request.headers?.["Content-Type"] === "application/json";
+      const isWriteMethod = ["POST", "PUT", "PATCH"].includes(
+        request.method?.toUpperCase() || ""
+      );
+      if (isJsonContentType && isWriteMethod && request.data === void 0) {
+        request.data = {};
+      }
+      return request;
+    },
+    (error) => {
+      return Promise.reject(error);
+    }
+  );
+  instance.interceptors.response.use(
+    (response) => {
+      return response;
+    },
+    (error) => {
+      if (error.response) {
+        const message = error.response.data?.message || error.message || "Request failed";
+        throw new MotifSDKError(
+          message,
+          error.response.status,
+          error.response.data
+        );
+      } else if (error.request) {
+        throw new MotifSDKError("No response received from server");
+      } else {
+        throw new MotifSDKError(error.message);
+      }
+    }
+  );
+  try {
+    const response = await instance.request(requestConfig);
+    return response.data;
+  } catch (error) {
+    if (error instanceof MotifSDKError) {
+      throw error;
+    }
+    throw new MotifSDKError(
+      error instanceof Error ? error.message : "Unknown error"
+    );
+  }
+};
+
+// src/generated/sdk/sdk.ts
+var getSdk = () => {
+  const sdkUsersCreate = (sdkUsersCreateBody) => {
+    return customInstance({
+      url: `/v1/sdk/users`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: sdkUsersCreateBody
+    });
+  };
+  const sdkUsersList = (params) => {
+    return customInstance({
+      url: `/v1/sdk/users`,
+      method: "GET",
+      params
+    });
+  };
+  const sdkUsersGet = (id) => {
+    return customInstance({
+      url: `/v1/sdk/users/${id}`,
+      method: "GET"
+    });
+  };
+  const sdkUsersUpdate = (id, sdkUsersUpdateBody) => {
+    return customInstance({
+      url: `/v1/sdk/users/${id}`,
+      method: "PATCH",
+      headers: { "Content-Type": "application/json" },
+      data: sdkUsersUpdateBody
+    });
+  };
+  const sdkUsersDelete = (id) => {
+    return customInstance({
+      url: `/v1/sdk/users/${id}`,
+      method: "DELETE"
+    });
+  };
+  const sdkUsersGetByExternalId = (externalId) => {
+    return customInstance({
+      url: `/v1/sdk/users/external/${externalId}`,
+      method: "GET"
+    });
+  };
+  const sdkProfileGetQuestions = (params) => {
+    return customInstance({
+      url: `/v1/sdk/profile/questions`,
+      method: "GET",
+      params
+    });
+  };
+  const sdkProfileSaveAnswer = (sdkProfileSaveAnswerBody) => {
+    return customInstance({
+      url: `/v1/sdk/profile/answers`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: sdkProfileSaveAnswerBody
+    });
+  };
+  const sdkProfileGetAnswers = () => {
+    return customInstance({
+      url: `/v1/sdk/profile/answers`,
+      method: "GET"
+    });
+  };
+  const sdkProfileGetInvestorProfile = () => {
+    return customInstance({
+      url: `/v1/sdk/profile/investor-profile`,
+      method: "GET"
+    });
+  };
+  const sdkProfileComputeInvestorProfile = (sdkProfileComputeInvestorProfileBody) => {
+    return customInstance({
+      url: `/v1/sdk/profile/investor-profile/compute`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: sdkProfileComputeInvestorProfileBody
+    });
+  };
+  const sdkProfileGetCompletion = (params) => {
+    return customInstance({
+      url: `/v1/sdk/profile/completion`,
+      method: "GET",
+      params
+    });
+  };
+  const sdkStrategiesGetRecommended = () => {
+    return customInstance({
+      url: `/v1/sdk/strategies/recommended`,
+      method: "GET"
+    });
+  };
+  const sdkStrategiesGenerate = (sdkStrategiesGenerateBody) => {
+    return customInstance({
+      url: `/v1/sdk/strategies/generate`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: sdkStrategiesGenerateBody
+    });
+  };
+  return {
+    sdkUsersCreate,
+    sdkUsersList,
+    sdkUsersGet,
+    sdkUsersUpdate,
+    sdkUsersDelete,
+    sdkUsersGetByExternalId,
+    sdkProfileGetQuestions,
+    sdkProfileSaveAnswer,
+    sdkProfileGetAnswers,
+    sdkProfileGetInvestorProfile,
+    sdkProfileComputeInvestorProfile,
+    sdkProfileGetCompletion,
+    sdkStrategiesGetRecommended,
+    sdkStrategiesGenerate
+  };
+};
+
+// src/generated/models/adminApiKeysCreateBodyEnvironment.ts
+var AdminApiKeysCreateBodyEnvironment = {
+  production: "production",
+  sandbox: "sandbox"
+};
+
+// src/generated/models/adminConfigUpdateInvestmentConfigBodyConfigDexRouteOrder.ts
+var AdminConfigUpdateInvestmentConfigBodyConfigDexRouteOrder = {
+  CHEAPEST: "CHEAPEST",
+  FASTEST: "FASTEST",
+  SAFEST: "SAFEST"
+};
+
+// src/generated/models/adminConfigUpdateInvestmentConfigBodyConfigDexRouteSelectionHierarchyItem.ts
+var AdminConfigUpdateInvestmentConfigBodyConfigDexRouteSelectionHierarchyItem = {
+  RECOMMENDED: "RECOMMENDED",
+  CHEAPEST: "CHEAPEST",
+  FASTEST: "FASTEST"
+};
+
+// src/generated/models/adminConfigUpdateTransactionConfigBodyConfigRouteSelectionHierarchyItem.ts
+var AdminConfigUpdateTransactionConfigBodyConfigRouteSelectionHierarchyItem = {
+  RECOMMENDED: "RECOMMENDED",
+  CHEAPEST: "CHEAPEST",
+  FASTEST: "FASTEST"
+};
+
+// src/generated/models/adminOrganizationInviteOrgAdminBodyRole.ts
+var AdminOrganizationInviteOrgAdminBodyRole = {
+  member: "member",
+  admin: "admin",
+  owner: "owner"
+};
+
+// src/generated/models/adminUserUpdateMemberRoleBodyRole.ts
+var AdminUserUpdateMemberRoleBodyRole = {
+  member: "member",
+  admin: "admin",
+  owner: "owner"
+};
+
+// src/generated/models/marketDataGetLatestMarketDataProvider.ts
+var MarketDataGetLatestMarketDataProvider = {
+  COINMARKETCAP: "COINMARKETCAP",
+  LIFI: "LIFI",
+  TIINGO: "TIINGO"
+};
+
+// src/generated/models/marketDataGetLatestMarketDataResolution.ts
+var MarketDataGetLatestMarketDataResolution = {
+  AD_HOC: "AD_HOC",
+  FIVE_MIN: "FIVE_MIN",
+  FIFTEEN_MIN: "FIFTEEN_MIN",
+  ONE_HOUR: "ONE_HOUR",
+  ONE_DAY: "ONE_DAY"
+};
+
+// src/generated/models/sdkProfileGetAnswers200ItemTier.ts
+var SdkProfileGetAnswers200ItemTier = {
+  Basic: "Basic",
+  Advanced: "Advanced",
+  KYC: "KYC"
+};
+
+// src/generated/models/sdkProfileGetCompletionTier.ts
+var SdkProfileGetCompletionTier = {
+  Basic: "Basic",
+  Advanced: "Advanced",
+  KYC: "KYC"
+};
+
+// src/generated/models/sdkProfileGetQuestions200ItemAction.ts
+var SdkProfileGetQuestions200ItemAction = {
+  SingleSelect: "SingleSelect",
+  MultiSelect: "MultiSelect",
+  Matrix: "Matrix",
+  NumberInput: "NumberInput",
+  PercentageSlider: "PercentageSlider"
+};
+
+// src/generated/models/sdkProfileGetQuestions200ItemType.ts
+var SdkProfileGetQuestions200ItemType = {
+  Basic: "Basic",
+  Advanced: "Advanced",
+  KYC: "KYC"
+};
+
+// src/generated/models/sdkProfileGetQuestionsType.ts
+var SdkProfileGetQuestionsType = {
+  Basic: "Basic",
+  Advanced: "Advanced",
+  KYC: "KYC"
+};
+
+// src/index.ts
+function createClient(config2) {
+  configure(config2);
+  const sdk = getSdk();
+  return {
+    /**
+     * User management operations (organization-level)
+     *
+     * These operations require only an API key and operate at the
+     * organization level. Use these to manage end users within your organization.
+     */
+    users: {
+      /**
+       * Create a new end user in the organization
+       * @param data - User data (email, name, optional externalId)
+       */
+      create: sdk.sdkUsersCreate,
+      /**
+       * List all users in the organization with pagination
+       * @param params - Optional pagination params (limit, cursor)
+       */
+      list: sdk.sdkUsersList,
+      /**
+       * Get a user by their internal Motif ID
+       * @param id - User ID
+       */
+      get: sdk.sdkUsersGet,
+      /**
+       * Update user details
+       * @param id - User ID
+       * @param data - Updated user data
+       */
+      update: sdk.sdkUsersUpdate,
+      /**
+       * Delete a user permanently
+       * @param id - User ID
+       */
+      delete: sdk.sdkUsersDelete,
+      /**
+       * Get a user by their external ID (partner-defined identifier)
+       * @param externalId - External ID
+       */
+      getByExternalId: sdk.sdkUsersGetByExternalId
+    },
+    /**
+     * Create a user-specific client for profile and strategy operations
+     *
+     * These operations require both an API key and a user context (x-user-id header).
+     * Use this method to perform operations on behalf of a specific user.
+     *
+     * @param userId - The ID of the user to perform operations for
+     * @returns User-scoped client with profile and strategies namespaces
+     *
+     * @example
+     * ```typescript
+     * const userClient = client.forUser('user_123')
+     * const questions = await userClient.profile.getQuestions({ type: 'Basic' })
+     * ```
+     */
+    forUser: (userId) => {
+      configure({
+        ...config2,
+        headers: {
+          ...config2.headers,
+          "x-user-id": userId
+        }
+      });
+      const userSdk = getSdk();
+      return {
+        /**
+         * User profiling operations
+         *
+         * Manage investor profiling questionnaires and computed profiles.
+         */
+        profile: {
+          /**
+           * Get profiling questions for a specific tier
+           * @param params - Question type (Basic, Advanced, or KYC)
+           */
+          getQuestions: userSdk.sdkProfileGetQuestions,
+          /**
+           * Save an answer to a profiling question
+           * @param data - Question ID and answer
+           */
+          saveAnswer: userSdk.sdkProfileSaveAnswer,
+          /**
+           * Get all profiling answers for the user
+           */
+          getAnswers: userSdk.sdkProfileGetAnswers,
+          /**
+           * Get the computed investor profile
+           */
+          getInvestorProfile: userSdk.sdkProfileGetInvestorProfile,
+          /**
+           * Compute or refresh the investor profile based on current answers
+           * @param data - Optional parameters
+           */
+          computeInvestorProfile: userSdk.sdkProfileComputeInvestorProfile,
+          /**
+           * Get profiling completion status for a tier
+           * @param params - Tier to check (Basic, Advanced, or KYC)
+           */
+          getCompletion: userSdk.sdkProfileGetCompletion
+        },
+        /**
+         * Investment strategy operations
+         *
+         * Get personalized investment strategy recommendations.
+         */
+        strategies: {
+          /**
+           * Get the recommended investment strategy for the user
+           */
+          getRecommended: userSdk.sdkStrategiesGetRecommended,
+          /**
+           * Generate a new AI-powered investment strategy
+           * @param data - Optional generation parameters
+           */
+          generate: userSdk.sdkStrategiesGenerate
+        }
+      };
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AdminApiKeysCreateBodyEnvironment,
+  AdminConfigUpdateInvestmentConfigBodyConfigDexRouteOrder,
+  AdminConfigUpdateInvestmentConfigBodyConfigDexRouteSelectionHierarchyItem,
+  AdminConfigUpdateTransactionConfigBodyConfigRouteSelectionHierarchyItem,
+  AdminOrganizationInviteOrgAdminBodyRole,
+  AdminUserUpdateMemberRoleBodyRole,
+  MarketDataGetLatestMarketDataProvider,
+  MarketDataGetLatestMarketDataResolution,
+  MotifSDKError,
+  SdkProfileGetAnswers200ItemTier,
+  SdkProfileGetCompletionTier,
+  SdkProfileGetQuestions200ItemAction,
+  SdkProfileGetQuestions200ItemType,
+  SdkProfileGetQuestionsType,
+  createClient
+});
+//# sourceMappingURL=index.cjs.map