@spottoai/types-package 1.0.2-beta.17 → 1.0.2-beta.171

package/LICENSE

@@ -1,43 +1,21 @@
-PROPRIETARY LICENSE AGREEMENT
+MIT License
 
 Copyright (c) 2024 Spotto AI (www.spotto.ai)
 
-This software and associated documentation files (the "Software") are the proprietary 
-and confidential information of Spotto AI. The Software is made available publicly 
-solely for internal use by Spotto AI and its authorized projects.
-
-RESTRICTIONS:
-
-1. NO PERMISSION TO USE: Except as expressly stated below, no person or entity is 
-   granted any right, title, or interest in or to the Software.
-
-2. INTERNAL USE ONLY: The Software may only be used internally by Spotto AI and its 
-   authorized projects for development, testing, and deployment purposes.
-
-3. NO REDISTRIBUTION: The Software may not be redistributed, sold, leased, or 
-   otherwise made available to third parties.
-
-4. NO DERIVATIVE WORKS: No derivative works based on the Software may be created 
-   without explicit written permission from Spotto AI.
-
-5. NO REVERSE ENGINEERING: Reverse engineering, disassembly, or decompilation of 
-   the Software is strictly prohibited.
-
-6. NO COMMERCIAL USE: Commercial use of the Software by any entity other than 
-   Spotto AI is strictly prohibited.
-
-DISCLAIMER:
-
-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.
-
-VIOLATION:
-
-Any unauthorized use, distribution, or modification of this Software constitutes 
-a violation of this license agreement and may result in legal action.
-
-For licensing inquiries, contact: contact@spotto.ai
+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

@@ -1,23 +1,19 @@
 # Types Package
 
-A shared TypeScript interfaces package for private repositories. This package contains common interfaces that can be reused across your API, frontend, and backend projects.
-**⚠️ RESTRICTED USE - INTERNAL SPOTTO AI ONLY ⚠️**
+A shared TypeScript interfaces package. This package contains common interfaces that can be reused across your API, frontend, and backend projects.
 
-This is a proprietary TypeScript interfaces package for internal use by Spotto AI (www.spotto.ai) only. This package contains common interfaces that can be reused across Spotto AI's API, frontend, and backend projects.
 
-**IMPORTANT**: This repository is made public solely for internal sharing between Spotto AI projects. External use, distribution, or modification is strictly prohibited. See LICENSE file for full terms.
 
 ## Features
 
 - **Shared Interfaces**: Common TypeScript interfaces for API requests/responses, database models, frontend components, and backend services
-- **Git Dependencies**: Designed to work with Git dependencies for private repositories
+- **Git Dependencies**: Designed to work with Git dependencies
 - **TypeScript Declaration Files**: Built with declaration files for better IDE support
 - **Modular Structure**: Organized by domain (API, Database, Frontend, Backend)
 
 ## Installation
 
-Since this is a private repository, you'll need to use Git dependencies instead of npm. Add this to your consuming project's `package.json`:
-Since this is an internal Spotto AI package, you'll need to use Git dependencies. Add this to your consuming project's `package.json`:
+Add this to your consuming project's `package.json`:
 
 ```json
 {
@@ -114,7 +110,4 @@ This package follows semantic versioning. When making changes:
 
 ## License
 
-MIT License - see LICENSE file for details
-**PROPRIETARY LICENSE** - This software is proprietary to Spotto AI and is made available publicly solely for internal use. External use, distribution, or modification is strictly prohibited. See LICENSE file for full terms and restrictions.
-
-For licensing inquiries, contact: legal@spotto.ai
+MIT License - see LICENSE file for details

package/dist/accounts/accounts.d.ts

@@ -1,10 +1,17 @@
 import { SurveyResponse } from '../company';
+export type SubscriptionType = 'Production' | 'Non-Production' | 'Mixed';
 export interface CloudAccount {
+    /** Partition Key */
     companyId: string;
+    /** Row Key (Azure Client ID, AWS Access Key ID) */
     id: string;
     name: string;
     companyName: string;
+    /** AWS, Azure, GCP, etc. */
     provider: string;
+    /** Optional list of subscription group names for this cloud account */
+    groupNames?: string[];
+    /** Azure Tenant ID */
     tenantId?: string;
     secret?: string;
     secretExpiresAt?: Date;
@@ -13,14 +20,24 @@ export interface CloudAccount {
     createdBy: string;
     status: string;
     objectives?: SurveyResponse[];
+    writeSecret?: string;
+    writeSecretExpiresAt?: Date;
+    writeClientId?: string;
+    writeBitmask?: number;
 }
-export interface SubscriptionAccount {
-    id: string;
-    companyId: string;
+export interface SubscriptionInfoBase {
     name: string;
+    friendlyName?: string;
     cloudAccountId: string;
     cloudAccountName: string;
+    /** Optional group name for subscription-level grouping */
+    groupName?: string;
+    /** Optional emoji shortcode (Slack-style, e.g. "/face") */
+    icon?: string;
+    /** Optional subscription type (Production, Non-Production, Mixed) */
+    subscriptionType?: SubscriptionType;
     status?: string;
+    statusLabel?: string;
     error?: string;
     lastUpdated?: string;
     quotaId?: string;
@@ -29,5 +46,17 @@ export interface SubscriptionAccount {
     currencySymbol?: string;
     foundCurrency?: boolean;
     ready?: boolean;
+    secureScore?: number;
+    showAmortizedCosts?: boolean;
+    totalCost?: number;
+    billingItems?: number;
+    activityItems?: number;
+    eventId?: string;
+}
+export interface SubscriptionAccount extends SubscriptionInfoBase {
+    /** Partition Key (Azure Subscription ID) */
+    id: string;
+    /** Row Key */
+    companyId: string;
 }
 //# sourceMappingURL=accounts.d.ts.map

package/dist/accounts/accounts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../src/accounts/accounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,IAAI,CAAC;IACvB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB"}
+{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../src/accounts/accounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG,gBAAgB,GAAG,OAAO,CAAC;AAEzE,MAAM,WAAW,YAAY;IAC3B,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,sBAAsB;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,IAAI,CAAC;IACvB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB,CAAC,EAAE,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,4CAA4C;IAC5C,EAAE,EAAE,MAAM,CAAC;IACX,cAAc;IACd,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/accounts/index.d.ts

@@ -1,2 +1,3 @@
 export * from './accounts';
+export * from './writePermissions';
 //# sourceMappingURL=index.d.ts.map

package/dist/accounts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/accounts/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/accounts/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC"}

package/dist/accounts/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./accounts"), exports);
+__exportStar(require("./writePermissions"), exports);
 //# sourceMappingURL=index.js.map

package/dist/accounts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/accounts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/accounts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,qDAAmC"}

package/dist/accounts/writePermissions.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Write Permission Bitmask Enum
+ * Each permission gets a unique bit position for efficient storage
+ */
+export declare enum WritePermission {
+    /** Permission to dismiss Azure Advisor recommendations */
+    DismissRecommendations = 1,// 1
+    /** Permission to enable storage inventory reports on storage accounts */
+    StorageInventory = 2
+}
+/**
+ * Metadata for a write permission
+ * Contains display information, required roles, and documentation links
+ */
+export interface WritePermissionMetadata {
+    /** Unique identifier matching the WritePermission enum */
+    id: WritePermission;
+    /** Human-readable display name */
+    displayName: string;
+    /** Description of what this permission allows */
+    description: string;
+    /** Required Azure RBAC role(s) for this permission */
+    requiredRoles: string[];
+    /** URL to documentation about this permission */
+    documentationUrl?: string;
+    /** URL to script generator for creating custom roles */
+    scriptGeneratorUrl?: string;
+}
+/**
+ * Permission metadata array
+ * Define all available write permissions with their metadata
+ */
+export declare const WRITE_PERMISSIONS_METADATA: WritePermissionMetadata[];
+//# sourceMappingURL=writePermissions.d.ts.map

package/dist/accounts/writePermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writePermissions.d.ts","sourceRoot":"","sources":["../../src/accounts/writePermissions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,eAAe;IACzB,0DAA0D;IAC1D,sBAAsB,IAAS,CAAE,IAAI;IACrC,yEAAyE;IACzE,gBAAgB,IAAS;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,0DAA0D;IAC1D,EAAE,EAAE,eAAe,CAAC;IACpB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wDAAwD;IACxD,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,0BAA0B,EAAE,uBAAuB,EAiB/D,CAAC"}

package/dist/accounts/writePermissions.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WRITE_PERMISSIONS_METADATA = exports.WritePermission = void 0;
+/**
+ * Write Permission Bitmask Enum
+ * Each permission gets a unique bit position for efficient storage
+ */
+var WritePermission;
+(function (WritePermission) {
+    /** Permission to dismiss Azure Advisor recommendations */
+    WritePermission[WritePermission["DismissRecommendations"] = 1] = "DismissRecommendations";
+    /** Permission to enable storage inventory reports on storage accounts */
+    WritePermission[WritePermission["StorageInventory"] = 2] = "StorageInventory";
+})(WritePermission || (exports.WritePermission = WritePermission = {}));
+/**
+ * Permission metadata array
+ * Define all available write permissions with their metadata
+ */
+exports.WRITE_PERMISSIONS_METADATA = [
+    {
+        id: WritePermission.DismissRecommendations,
+        displayName: 'Dismiss Azure Advisor Recommendations',
+        description: 'Allows Spotto to dismiss recommendations in Azure when dismissed here.',
+        requiredRoles: ['Advisor Recommendations Contributor'],
+        documentationUrl: 'https://learn.microsoft.com/en-us/azure/advisor/permissions',
+        scriptGeneratorUrl: '/scripts/advisor-role',
+    },
+    {
+        id: WritePermission.StorageInventory,
+        displayName: 'Enable Storage Inventory Reports',
+        description: 'Allows Spotto to enable blob inventory on storage accounts you select.',
+        requiredRoles: ['Storage Account Contributor'],
+        documentationUrl: 'https://learn.microsoft.com/en-us/azure/storage/blobs/blob-inventory',
+        scriptGeneratorUrl: '/scripts/storage-role',
+    },
+];
+//# sourceMappingURL=writePermissions.js.map

package/dist/accounts/writePermissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writePermissions.js","sourceRoot":"","sources":["../../src/accounts/writePermissions.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,0DAA0D;IAC1D,yFAA+B,CAAA;IAC/B,yEAAyE;IACzE,6EAAyB,CAAA;AAC3B,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAqBD;;;GAGG;AACU,QAAA,0BAA0B,GAA8B;IACnE;QACE,EAAE,EAAE,eAAe,CAAC,sBAAsB;QAC1C,WAAW,EAAE,uCAAuC;QACpD,WAAW,EAAE,wEAAwE;QACrF,aAAa,EAAE,CAAC,qCAAqC,CAAC;QACtD,gBAAgB,EAAE,6DAA6D;QAC/E,kBAAkB,EAAE,uBAAuB;KAC5C;IACD;QACE,EAAE,EAAE,eAAe,CAAC,gBAAgB;QACpC,WAAW,EAAE,kCAAkC;QAC/C,WAAW,EAAE,wEAAwE;QACrF,aAAa,EAAE,CAAC,6BAA6B,CAAC;QAC9C,gBAAgB,EAAE,sEAAsE;QACxF,kBAAkB,EAAE,uBAAuB;KAC5C;CACF,CAAC"}