@tmdjr/ngx-mfe-orchestrator-contracts 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export type { AuthTestDto } from './models/AuthTestDto';
+export type { CreateMfeRemoteDto } from './models/CreateMfeRemoteDto';
+export type { MfeRemoteDto } from './models/MfeRemoteDto';
+export type { MfeRemoteType } from './models/MfeRemoteType';
+export type { StructuralNavOverrideMode } from './models/StructuralNavOverrideMode';
+export type { StructuralOverrideMode } from './models/StructuralOverrideMode';
+export type { StructuralOverridesDto } from './models/StructuralOverridesDto';
+export type { StructuralSubType } from './models/StructuralSubType';
+export type { UpdateMfeRemoteDto } from './models/UpdateMfeRemoteDto';

package/dist/index.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/dist/models/AuthTestDto.d.ts

@@ -0,0 +1,3 @@
+export type AuthTestDto = {
+    message: string;
+};

package/dist/models/AuthTestDto.js

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

package/dist/models/CreateMfeRemoteDto.d.ts

@@ -0,0 +1,18 @@
+import type { MfeRemoteType } from './MfeRemoteType';
+import type { StructuralNavOverrideMode } from './StructuralNavOverrideMode';
+import type { StructuralOverrideMode } from './StructuralOverrideMode';
+import type { StructuralOverridesDto } from './StructuralOverridesDto';
+import type { StructuralSubType } from './StructuralSubType';
+export type CreateMfeRemoteDto = {
+    name: string;
+    remoteEntryUrl: string;
+    status?: string;
+    description?: string;
+    archived?: boolean;
+    type: MfeRemoteType;
+    structuralOverrides?: StructuralOverridesDto;
+    structuralOverridesHeader?: StructuralOverrideMode;
+    structuralOverridesNav?: StructuralNavOverrideMode;
+    structuralOverridesFooter?: StructuralOverrideMode;
+    structuralSubType?: StructuralSubType;
+};

package/dist/models/CreateMfeRemoteDto.js

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

package/dist/models/MfeRemoteDto.d.ts

@@ -0,0 +1,15 @@
+import type { StructuralOverridesDto } from './StructuralOverridesDto';
+export type MfeRemoteDto = {
+    _id: string;
+    name: string;
+    remoteEntryUrl: string;
+    type: 'structural' | 'user-journey';
+    structuralOverrides?: StructuralOverridesDto;
+    structuralSubType?: 'header' | 'nav' | 'footer';
+    version: number;
+    status?: string;
+    description: string;
+    lastUpdated: string;
+    archived: boolean;
+    __v: number;
+};

package/dist/models/MfeRemoteDto.js

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

package/dist/models/MfeRemoteType.d.ts

@@ -0,0 +1 @@
+export type MfeRemoteType = 'structural' | 'user-journey';

package/dist/models/MfeRemoteType.js

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

package/dist/models/StructuralNavOverrideMode.d.ts

@@ -0,0 +1 @@
+export type StructuralNavOverrideMode = 'verbose' | 'minimal' | 'disabled';

package/dist/models/StructuralNavOverrideMode.js

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

package/dist/models/StructuralOverrideMode.d.ts

@@ -0,0 +1 @@
+export type StructuralOverrideMode = 'full' | 'relaxed' | 'compact' | 'disabled';

package/dist/models/StructuralOverrideMode.js

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

package/dist/models/StructuralOverridesDto.d.ts

@@ -0,0 +1,5 @@
+export type StructuralOverridesDto = {
+    header?: 'full' | 'relaxed' | 'compact' | 'disabled';
+    nav?: 'verbose' | 'minimal' | 'disabled';
+    footer?: 'full' | 'relaxed' | 'compact' | 'disabled';
+};

package/dist/models/StructuralOverridesDto.js

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

package/dist/models/StructuralSubType.d.ts

@@ -0,0 +1 @@
+export type StructuralSubType = 'header' | 'nav' | 'footer';

package/dist/models/StructuralSubType.js

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

package/dist/models/UpdateMfeRemoteDto.d.ts

@@ -0,0 +1,18 @@
+import type { MfeRemoteType } from './MfeRemoteType';
+import type { StructuralNavOverrideMode } from './StructuralNavOverrideMode';
+import type { StructuralOverrideMode } from './StructuralOverrideMode';
+import type { StructuralOverridesDto } from './StructuralOverridesDto';
+import type { StructuralSubType } from './StructuralSubType';
+export type UpdateMfeRemoteDto = {
+    name?: string;
+    remoteEntryUrl?: string;
+    status?: string;
+    description?: string;
+    archived?: boolean;
+    type?: MfeRemoteType;
+    structuralOverrides?: StructuralOverridesDto;
+    structuralOverridesHeader?: StructuralOverrideMode;
+    structuralOverridesNav?: StructuralNavOverrideMode;
+    structuralOverridesFooter?: StructuralOverrideMode;
+    structuralSubType?: StructuralSubType;
+};

package/dist/models/UpdateMfeRemoteDto.js

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

package/dist/orchestrator.types.d.ts

@@ -0,0 +1,409 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/mfe-remotes/auth-test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["MfeRemoteController_authTest"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/mfe-remotes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["MfeRemoteController_findAll"];
+        put?: never;
+        post: operations["MfeRemoteController_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/mfe-remotes/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["MfeRemoteController_findOne"];
+        put?: never;
+        post?: never;
+        delete: operations["MfeRemoteController_remove"];
+        options?: never;
+        head?: never;
+        patch: operations["MfeRemoteController_update"];
+        trace?: never;
+    };
+    "/mfe-remotes/name/{name}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["MfeRemoteController_findByName"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/mfe-remotes/{id}/archive": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch: operations["MfeRemoteController_archive"];
+        trace?: never;
+    };
+    "/mfe-remotes/{id}/unarchive": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch: operations["MfeRemoteController_unarchive"];
+        trace?: never;
+    };
+    "/mfe-remotes/{id}/status": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch: operations["MfeRemoteController_updateStatus"];
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        AuthTestDto: {
+            message: string;
+        };
+        /** @enum {string} */
+        MfeRemoteType: "structural" | "user-journey";
+        StructuralOverridesDto: {
+            /** @enum {string} */
+            header?: "full" | "relaxed" | "compact" | "disabled";
+            /** @enum {string} */
+            nav?: "verbose" | "minimal" | "disabled";
+            /** @enum {string} */
+            footer?: "full" | "relaxed" | "compact" | "disabled";
+        };
+        /** @enum {string} */
+        StructuralOverrideMode: "full" | "relaxed" | "compact" | "disabled";
+        /** @enum {string} */
+        StructuralNavOverrideMode: "verbose" | "minimal" | "disabled";
+        /** @enum {string} */
+        StructuralSubType: "header" | "nav" | "footer";
+        CreateMfeRemoteDto: {
+            name: string;
+            /** Format: uri */
+            remoteEntryUrl: string;
+            status?: string;
+            description?: string;
+            archived?: boolean;
+            type: components["schemas"]["MfeRemoteType"];
+            structuralOverrides?: components["schemas"]["StructuralOverridesDto"];
+            structuralOverridesHeader?: components["schemas"]["StructuralOverrideMode"];
+            structuralOverridesNav?: components["schemas"]["StructuralNavOverrideMode"];
+            structuralOverridesFooter?: components["schemas"]["StructuralOverrideMode"];
+            structuralSubType?: components["schemas"]["StructuralSubType"];
+        };
+        MfeRemoteDto: {
+            _id: string;
+            name: string;
+            /** Format: uri */
+            remoteEntryUrl: string;
+            /** @enum {string} */
+            type: "structural" | "user-journey";
+            structuralOverrides?: components["schemas"]["StructuralOverridesDto"];
+            /** @enum {string} */
+            structuralSubType?: "header" | "nav" | "footer";
+            version: number;
+            status?: string;
+            description: string;
+            /** Format: date-time */
+            lastUpdated: string;
+            archived: boolean;
+            __v: number;
+        };
+        UpdateMfeRemoteDto: {
+            name?: string;
+            /** Format: uri */
+            remoteEntryUrl?: string;
+            status?: string;
+            description?: string;
+            archived?: boolean;
+            type?: components["schemas"]["MfeRemoteType"];
+            structuralOverrides?: components["schemas"]["StructuralOverridesDto"];
+            structuralOverridesHeader?: components["schemas"]["StructuralOverrideMode"];
+            structuralOverridesNav?: components["schemas"]["StructuralNavOverrideMode"];
+            structuralOverridesFooter?: components["schemas"]["StructuralOverrideMode"];
+            structuralSubType?: components["schemas"]["StructuralSubType"];
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    MfeRemoteController_authTest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthTestDto"];
+                };
+            };
+        };
+    };
+    MfeRemoteController_findAll: {
+        parameters: {
+            query?: {
+                /** @description Filter by archived status */
+                archived?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MfeRemoteDto"][];
+                };
+            };
+        };
+    };
+    MfeRemoteController_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateMfeRemoteDto"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MfeRemoteDto"];
+                };
+            };
+        };
+    };
+    MfeRemoteController_findOne: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MfeRemoteDto"];
+                };
+            };
+        };
+    };
+    MfeRemoteController_remove: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    MfeRemoteController_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateMfeRemoteDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MfeRemoteDto"];
+                };
+            };
+        };
+    };
+    MfeRemoteController_findByName: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                name: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MfeRemoteDto"];
+                };
+            };
+        };
+    };
+    MfeRemoteController_archive: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MfeRemoteDto"];
+                };
+            };
+        };
+    };
+    MfeRemoteController_unarchive: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MfeRemoteDto"];
+                };
+            };
+        };
+    };
+    MfeRemoteController_updateStatus: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MfeRemoteDto"];
+                };
+            };
+        };
+    };
+}

package/dist/orchestrator.types.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tmdjr/ngx-mfe-orchestrator-contracts",
+  "version": "0.0.1",
+  "description": "Types & runtime enums generated from NGX MFE Orchestrator OpenAPI spec",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf dist src/orchestrator.types.ts src/models src/core src/schemas",
+    "gen:types": "openapi-typescript ../../openapi.json --output ./src/orchestrator.types.ts",
+    "gen:models": "openapi --input ../../openapi.json --output ./src --client none --exportCore false --exportServices false --exportModels true --useUnionTypes true",
+    "gen": "npm run gen:types && npm run gen:models",
+    "build": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run clean && npm run gen && npm run build"
+  },
+  "devDependencies": {
+    "openapi-typescript": "^7.5.1",
+    "typescript": "^5.7.3",
+    "openapi-typescript-codegen": "^0.29.0"
+  }
+}