@tolinax/ayoune-interfaces 2025.16.6 → 2025.16.7

package/api/IAPIAction.d.ts

@@ -0,0 +1,9 @@
+export interface IAPIAction {
+    action: string;
+    title: string;
+    href: string;
+    method: "get" | "put" | "post" | "delete";
+    rel: string;
+    types?: string[];
+    right?: string;
+}

package/api/IAPIAction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/IAPILink.d.ts

@@ -0,0 +1,8 @@
+export interface IAPILink {
+    rel: string;
+    title: string;
+    href: string;
+    method: "get" | "put" | "post" | "delete";
+    types: string[];
+    right?: string;
+}

package/api/IAPILink.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/IAPIRelation.d.ts

@@ -0,0 +1,8 @@
+export interface IAPIRelation {
+    rel: string;
+    title: string;
+    href: string;
+    method: "get" | "put" | "post" | "delete";
+    types: string[];
+    right?: string;
+}

package/api/IAPIRelation.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/IAPIResult.d.ts

@@ -0,0 +1,75 @@
+import { IAPIAction } from "./IAPIAction";
+import { IAPILink } from "./IAPILink";
+import { IAPIRelation } from "./IAPIRelation";
+import { IResponseRateLimit } from "./IResponseLocals";
+import { IGeoIPLocationTracking } from "../interfaces";
+/**
+ * Represents the meta data of an API result.
+ * @interface
+ */
+export interface IAPIResultMeta {
+    status?: "success" | "pending" | "failure" | "no-user-right" | "no-customer-right" | "no-api-right" | "long-running-task" | "account-locked" | "not-authorized";
+    version?: {
+        host: string;
+        core: string;
+    };
+    internal?: {
+        infrastructure?: {
+            pod: string;
+            ip: string;
+            namespace: string;
+            component: string;
+            release: string;
+            partOf: string;
+            build: string;
+            commit: string;
+        };
+        hosts?: string[];
+        location: IGeoIPLocationTracking;
+        tracking: any;
+        inbound: any;
+    };
+    actions?: IAPIAction[];
+    reports?: {
+        _id: string;
+        label: string;
+    }[];
+    links: IAPILink[];
+    relations: IAPIRelation[];
+    message?: string;
+    deviceType?: string;
+    responseTime?: number;
+    filter?: any;
+    paths?: any;
+    cursor?: any;
+    fields?: any;
+    lrt?: boolean;
+    requiredRights?: string[];
+    module?: string;
+    model?: string;
+    rateLimit?: IResponseRateLimit;
+    pageInfo?: {
+        totalPages: number;
+        page: number;
+        totalEntries: number;
+    };
+    debugId?: string;
+    audit?: any;
+    error?: boolean;
+    removedFields?: [];
+    errors?: {
+        _id: string;
+        message: string;
+        code: number;
+    }[];
+    code?: number;
+}
+export interface IAPIResult {
+    payload?: any | any[];
+    meta?: IAPIResultMeta;
+    dataTable?: boolean;
+    draw?: string;
+    recordsTotal?: number;
+    recordsFiltered?: number;
+    data?: any[];
+}

package/api/IAPIResult.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/IResponseLocals.d.ts

@@ -0,0 +1,67 @@
+import { IAPILink } from "./IAPILink";
+import { IaYOUneUser, IConsumer } from "../interfaces";
+import { IaYOUneExpressOptions } from "./IaYOUneExpressOptions";
+export interface IResponseInboundTraffic {
+    trafficType: string;
+    network: string;
+    mailClient: string;
+    searchEngine: string;
+    site: string;
+}
+export interface IResponseLocationInfo {
+    range: number[];
+    country: string;
+    region: string;
+    eu: string;
+    timezone: string;
+    city: string;
+    ll: number[];
+    metro: number;
+    area: number;
+}
+export interface IResponseDevice {
+    type: string;
+    name: string;
+}
+export interface IResponseCursor {
+    skip: number;
+    limit: number;
+    [key: string]: any;
+}
+export interface IResponseRateLimit {
+    limit: string;
+    remaining: string;
+    reset: string;
+    resetDate: string;
+}
+export interface IResponseLocals {
+    id?: string;
+    ids?: string[];
+    errors?: any[];
+    user?: IaYOUneUser | IConsumer;
+    _consumer?: IConsumer;
+    options?: IaYOUneExpressOptions;
+    middlewareFlow?: string[];
+    startHrTime?: [number, number];
+    isValid?: boolean;
+    type?: string;
+    status?: number;
+    ip?: string;
+    location?: IResponseLocationInfo;
+    ayouneParams?: Record<string, string>;
+    inbound?: IResponseInboundTraffic;
+    device?: IResponseDevice;
+    responseData?: any;
+    debugId?: string;
+    module?: string;
+    space?: string;
+    fn?: string;
+    cursor?: IResponseCursor;
+    query?: any;
+    fields?: any;
+    plain?: boolean;
+    yaml?: boolean;
+    rateLimit?: IResponseRateLimit;
+    links?: IAPILink[];
+    [key: string]: any;
+}

package/api/IResponseLocals.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/IaYOUneExpressOptions.d.ts

@@ -0,0 +1,31 @@
+export interface IaYOUneExpressOptionsDocs {
+    disabled?: boolean;
+    swagger?: boolean;
+    redoc?: boolean;
+    route?: string;
+}
+export interface IaYOUneExpressOptionsOpenAPI {
+    coerce: boolean;
+    htmlui: boolean;
+    basePath: string;
+}
+export interface IaYOUneExpressRobotsOptions {
+    UserAgent: string;
+    Disallow?: string;
+    Allow?: string;
+    CrawlDelay?: string;
+    Sitemap?: string | string[];
+}
+export interface IaYOUneExpressOptions {
+    description?: string;
+    performanceTracking?: boolean;
+    enableDeviceHelpers?: boolean;
+    rateLimit?: boolean;
+    metrics?: boolean;
+    extractQuery?: boolean;
+    openapiOptions?: IaYOUneExpressOptionsOpenAPI;
+    docs?: IaYOUneExpressOptionsDocs;
+    modelNames?: string[];
+    robots?: IaYOUneExpressRobotsOptions | IaYOUneExpressRobotsOptions[];
+    cacheControl?: boolean;
+}

package/api/IaYOUneExpressOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./IAPIAction";
+export * from "./IAPILink";
+export * from "./IAPIRelation";
+export * from "./IAPIResult";
+export * from "./IaYOUneExpressOptions";
+export * from "./IResponseLocals";

package/api/index.js

@@ -0,0 +1,22 @@
+"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 });
+__exportStar(require("./IAPIAction"), exports);
+__exportStar(require("./IAPILink"), exports);
+__exportStar(require("./IAPIRelation"), exports);
+__exportStar(require("./IAPIResult"), exports);
+__exportStar(require("./IaYOUneExpressOptions"), exports);
+__exportStar(require("./IResponseLocals"), exports);

package/index.d.ts

@@ -3,3 +3,4 @@ declare global {
 }
 export * from "./interfaces";
 export * from "./data";
+export * from "./api";

package/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./interfaces"), exports);
 __exportStar(require("./data"), exports);
+__exportStar(require("./api"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-interfaces",
-  "version": "2025.16.6",
+  "version": "2025.16.7",
   "description": "Houses TypeScript interfaces for aYOUne",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",