@proxima-nexus/sdk-typescript 1.0.0

package/dist/base.d.ts

@@ -0,0 +1,42 @@
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}
+interface ServerMap {
+    [key: string]: {
+        url: string;
+        description: string;
+    }[];
+}
+export declare const operationServerMap: ServerMap;
+export {};

package/dist/base.js

@@ -0,0 +1,48 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
+const axios_1 = __importDefault(require("axios"));
+exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
+exports.COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+class BaseAPI {
+    constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
+        this.basePath = basePath;
+        this.axios = axios;
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath ?? basePath;
+        }
+    }
+}
+exports.BaseAPI = BaseAPI;
+;
+class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+exports.RequiredError = RequiredError;
+exports.operationServerMap = {};

package/dist/common.d.ts

@@ -0,0 +1,31 @@
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
+export declare const replaceWithSerializableTypeIfNeeded: (key: any, value: any) => any;
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+export declare const toPathString: (url: URL) => string;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/common.js

@@ -0,0 +1,98 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.replaceWithSerializableTypeIfNeeded = exports.setSearchParams = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
+const base_1 = require("./base");
+exports.DUMMY_BASE_URL = 'https://example.com';
+/**
+ *
+ * @throws {RequiredError}
+ */
+const assertParamExists = function (functionName, paramName, paramValue) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new base_1.RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+};
+exports.assertParamExists = assertParamExists;
+const setApiKeyToObject = async function (object, keyParamName, configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+};
+exports.setApiKeyToObject = setApiKeyToObject;
+function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
+            parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        }
+        else {
+            Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
+        }
+    }
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        }
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+const setSearchParams = function (url, ...objects) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+};
+exports.setSearchParams = setSearchParams;
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
+const replaceWithSerializableTypeIfNeeded = function (key, value) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    }
+    else {
+        return value;
+    }
+};
+exports.replaceWithSerializableTypeIfNeeded = replaceWithSerializableTypeIfNeeded;
+const serializeDataIfNeeded = function (value, requestOptions, configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {}, exports.replaceWithSerializableTypeIfNeeded)
+        : (value || "");
+};
+exports.serializeDataIfNeeded = serializeDataIfNeeded;
+const toPathString = function (url) {
+    return url.pathname + url.search + url.hash;
+};
+exports.toPathString = toPathString;
+const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
+    return (axios = globalAxios, basePath = BASE_PATH) => {
+        const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
+        return axios.request(axiosRequestArgs);
+    };
+};
+exports.createRequestFunction = createRequestFunction;

package/dist/configuration.d.ts

@@ -0,0 +1,98 @@
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface AWSv4Configuration {
+    options?: {
+        region?: string;
+        service?: string;
+    };
+    credentials?: {
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        sessionToken?: string;
+    };
+}
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
+     * @memberof Configuration
+     */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
+    basePath?: string;
+    /**
+     * override server index
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}
+export {};

package/dist/configuration.js

@@ -0,0 +1,48 @@
+"use strict";
+/* tslint:disable */
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+class Configuration {
+    constructor(param = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.awsv4 = param.awsv4;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = {
+            ...param.baseOptions,
+            headers: {
+                ...param.baseOptions?.headers,
+            },
+        };
+        this.formDataCtor = param.formDataCtor;
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}
+exports.Configuration = Configuration;

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { Configuration, ConfigurationParameters } from './configuration';
+import { UserApi } from './api/user-api';
+import { EventApi } from './api/event-api';
+import { GroupApi } from './api/group-api';
+export * from './models';
+export { UserApi, EventApi, GroupApi };
+export { Configuration, type ConfigurationParameters };
+/**
+ * Simplified configuration interface for the main client
+ */
+export interface ProximaNexusClientConfig {
+    /**
+     * API base URL
+     * @default "https://api.proxima-nexus.com"
+     */
+    baseURL?: string;
+    /**
+     * API key for authentication
+     * Required for all requests
+     */
+    apiKey: string;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Additional axios configuration
+     */
+    axiosConfig?: any;
+}
+export declare class ProximaNexusClient {
+    readonly users: UserApi;
+    readonly events: EventApi;
+    readonly groups: GroupApi;
+    constructor(config: ProximaNexusClientConfig);
+}
+export default ProximaNexusClient;

package/dist/index.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProximaNexusClient = exports.Configuration = exports.GroupApi = exports.EventApi = exports.UserApi = void 0;
+const configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.Configuration; } });
+const user_api_1 = require("./api/user-api");
+Object.defineProperty(exports, "UserApi", { enumerable: true, get: function () { return user_api_1.UserApi; } });
+const event_api_1 = require("./api/event-api");
+Object.defineProperty(exports, "EventApi", { enumerable: true, get: function () { return event_api_1.EventApi; } });
+const group_api_1 = require("./api/group-api");
+Object.defineProperty(exports, "GroupApi", { enumerable: true, get: function () { return group_api_1.GroupApi; } });
+// Export all types
+__exportStar(require("./models"), exports);
+class ProximaNexusClient {
+    constructor(config) {
+        const configuration = new configuration_1.Configuration({
+            apiKey: config.apiKey,
+            basePath: config.baseURL || 'https://api.proxima-nexus.com',
+            baseOptions: {
+                timeout: config.timeout || 30000,
+                ...config.axiosConfig,
+            },
+        });
+        this.users = new user_api_1.UserApi(configuration);
+        this.events = new event_api_1.EventApi(configuration);
+        this.groups = new group_api_1.GroupApi(configuration);
+    }
+}
+exports.ProximaNexusClient = ProximaNexusClient;
+exports.default = ProximaNexusClient;

package/dist/models/create-event-dto.d.ts

@@ -0,0 +1,63 @@
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { LocationDto } from './location-dto';
+export interface CreateEventDto {
+    /**
+     * Display name
+     */
+    'displayName': string;
+    /**
+     * User ID of the requester
+     */
+    'requesterUserId': string;
+    /**
+     * Visibility of the entity
+     */
+    'visibility': CreateEventDtoVisibilityEnum;
+    /**
+     * Optional location information
+     */
+    'location'?: LocationDto;
+    /**
+     * Entity description
+     */
+    'description'?: string;
+    /**
+     * Entity tags
+     */
+    'tags'?: Array<string>;
+    /**
+     * Unique event identifier
+     */
+    'eventId': string;
+    /**
+     * Start time (ISO 8601)
+     */
+    'startTime': string;
+    /**
+     * End time (ISO 8601)
+     */
+    'endTime': string;
+    /**
+     * Event type
+     */
+    'type': string;
+    /**
+     * Identifier of associated group which owns the event. Owners/admins of the group will be admins of the event.
+     */
+    'associatedGroupId'?: string;
+}
+export declare enum CreateEventDtoVisibilityEnum {
+    public = "public",
+    connections = "connections",
+    hidden = "hidden"
+}

package/dist/models/create-event-dto.js

@@ -0,0 +1,22 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateEventDtoVisibilityEnum = void 0;
+var CreateEventDtoVisibilityEnum;
+(function (CreateEventDtoVisibilityEnum) {
+    CreateEventDtoVisibilityEnum["public"] = "public";
+    CreateEventDtoVisibilityEnum["connections"] = "connections";
+    CreateEventDtoVisibilityEnum["hidden"] = "hidden";
+})(CreateEventDtoVisibilityEnum || (exports.CreateEventDtoVisibilityEnum = CreateEventDtoVisibilityEnum = {}));

package/dist/models/create-group-dto.d.ts

@@ -0,0 +1,51 @@
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { LocationDto } from './location-dto';
+export interface CreateGroupDto {
+    /**
+     * Display name
+     */
+    'displayName': string;
+    /**
+     * User ID of the requester
+     */
+    'requesterUserId': string;
+    /**
+     * Visibility of the entity
+     */
+    'visibility': CreateGroupDtoVisibilityEnum;
+    /**
+     * Optional location information
+     */
+    'location'?: LocationDto;
+    /**
+     * Entity description
+     */
+    'description'?: string;
+    /**
+     * Entity tags
+     */
+    'tags'?: Array<string>;
+    /**
+     * Unique group identifier
+     */
+    'groupId': string;
+    /**
+     * Group type
+     */
+    'type': string;
+}
+export declare enum CreateGroupDtoVisibilityEnum {
+    public = "public",
+    connections = "connections",
+    hidden = "hidden"
+}

package/dist/models/create-group-dto.js

@@ -0,0 +1,22 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateGroupDtoVisibilityEnum = void 0;
+var CreateGroupDtoVisibilityEnum;
+(function (CreateGroupDtoVisibilityEnum) {
+    CreateGroupDtoVisibilityEnum["public"] = "public";
+    CreateGroupDtoVisibilityEnum["connections"] = "connections";
+    CreateGroupDtoVisibilityEnum["hidden"] = "hidden";
+})(CreateGroupDtoVisibilityEnum || (exports.CreateGroupDtoVisibilityEnum = CreateGroupDtoVisibilityEnum = {}));

package/dist/models/create-user-dto.d.ts

@@ -0,0 +1,55 @@
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { LocationDto } from './location-dto';
+export interface CreateUserDto {
+    /**
+     * Display name
+     */
+    'displayName': string;
+    /**
+     * User ID of the requester
+     */
+    'requesterUserId': string;
+    /**
+     * Visibility of the entity
+     */
+    'visibility': CreateUserDtoVisibilityEnum;
+    /**
+     * Optional location information
+     */
+    'location'?: LocationDto;
+    /**
+     * Entity description
+     */
+    'description'?: string;
+    /**
+     * Entity tags
+     */
+    'tags'?: Array<string>;
+    /**
+     * Unique user identifier
+     */
+    'userId': string;
+    /**
+     * Gender
+     */
+    'gender': string;
+    /**
+     * Birth date (ISO 8601)
+     */
+    'birthDate': string;
+}
+export declare enum CreateUserDtoVisibilityEnum {
+    public = "public",
+    connections = "connections",
+    hidden = "hidden"
+}