@spottoai/types-package 1.0.2-beta.23 → 1.0.2-beta.233

package/dist/accounts/readPermissions.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Subscription-scoped read capability bitmask enum.
+ * Each capability maps to a single bit.
+ */
+export declare enum SubscriptionReadPermission {
+    /** Permission to read Azure Monitor metrics. */
+    MonitoringReader = 1,// 1
+    /** Permission to run Log Analytics / App Insights data queries. */
+    LogAnalyticsDataReader = 2
+}
+/**
+ * Cloud-account-scoped read capability bitmask enum.
+ * Each capability maps to a single bit.
+ */
+export declare enum CloudAccountReadPermission {
+    /** Permission to read management group entities. */
+    ManagementGroupReader = 1,// 1
+    /** Permission to read reservation resources and related consumption artifacts. */
+    ReservationsReader = 2,// 2
+    /** Permission to read savings plan resources. */
+    SavingsPlanReader = 4,// 4
+    /** Permission to read Microsoft Graph applications/service principals. */
+    GraphApplicationReadAll = 8
+}
+/**
+ * Metadata for a subscription-scoped read capability.
+ */
+export interface SubscriptionReadPermissionMetadata {
+    id: SubscriptionReadPermission;
+    displayName: string;
+    description: string;
+    requiredRoles: string[];
+}
+/**
+ * Metadata for a cloud-account-scoped read capability.
+ */
+export interface CloudAccountReadPermissionMetadata {
+    id: CloudAccountReadPermission;
+    displayName: string;
+    description: string;
+    requiredRoles: string[];
+}
+export declare const SUBSCRIPTION_READ_PERMISSIONS_METADATA: SubscriptionReadPermissionMetadata[];
+export declare const CLOUD_ACCOUNT_READ_PERMISSIONS_METADATA: CloudAccountReadPermissionMetadata[];
+//# sourceMappingURL=readPermissions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readPermissions.d.ts","sourceRoot":"","sources":["../../src/accounts/readPermissions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,0BAA0B;IACpC,gDAAgD;IAChD,gBAAgB,IAAS,CAAE,IAAI;IAC/B,mEAAmE;IACnE,sBAAsB,IAAS;CAChC;AAED;;;GAGG;AACH,oBAAY,0BAA0B;IACpC,oDAAoD;IACpD,qBAAqB,IAAS,CAAE,IAAI;IACpC,kFAAkF;IAClF,kBAAkB,IAAS,CAAE,IAAI;IACjC,iDAAiD;IACjD,iBAAiB,IAAS,CAAE,IAAI;IAChC,0EAA0E;IAC1E,uBAAuB,IAAS;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,EAAE,EAAE,0BAA0B,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,EAAE,EAAE,0BAA0B,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,eAAO,MAAM,sCAAsC,EAAE,kCAAkC,EAatF,CAAC;AAEF,eAAO,MAAM,uCAAuC,EAAE,kCAAkC,EAyBvF,CAAC"}

package/dist/accounts/readPermissions.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLOUD_ACCOUNT_READ_PERMISSIONS_METADATA = exports.SUBSCRIPTION_READ_PERMISSIONS_METADATA = exports.CloudAccountReadPermission = exports.SubscriptionReadPermission = void 0;
+/**
+ * Subscription-scoped read capability bitmask enum.
+ * Each capability maps to a single bit.
+ */
+var SubscriptionReadPermission;
+(function (SubscriptionReadPermission) {
+    /** Permission to read Azure Monitor metrics. */
+    SubscriptionReadPermission[SubscriptionReadPermission["MonitoringReader"] = 1] = "MonitoringReader";
+    /** Permission to run Log Analytics / App Insights data queries. */
+    SubscriptionReadPermission[SubscriptionReadPermission["LogAnalyticsDataReader"] = 2] = "LogAnalyticsDataReader";
+})(SubscriptionReadPermission || (exports.SubscriptionReadPermission = SubscriptionReadPermission = {}));
+/**
+ * Cloud-account-scoped read capability bitmask enum.
+ * Each capability maps to a single bit.
+ */
+var CloudAccountReadPermission;
+(function (CloudAccountReadPermission) {
+    /** Permission to read management group entities. */
+    CloudAccountReadPermission[CloudAccountReadPermission["ManagementGroupReader"] = 1] = "ManagementGroupReader";
+    /** Permission to read reservation resources and related consumption artifacts. */
+    CloudAccountReadPermission[CloudAccountReadPermission["ReservationsReader"] = 2] = "ReservationsReader";
+    /** Permission to read savings plan resources. */
+    CloudAccountReadPermission[CloudAccountReadPermission["SavingsPlanReader"] = 4] = "SavingsPlanReader";
+    /** Permission to read Microsoft Graph applications/service principals. */
+    CloudAccountReadPermission[CloudAccountReadPermission["GraphApplicationReadAll"] = 8] = "GraphApplicationReadAll";
+})(CloudAccountReadPermission || (exports.CloudAccountReadPermission = CloudAccountReadPermission = {}));
+exports.SUBSCRIPTION_READ_PERMISSIONS_METADATA = [
+    {
+        id: SubscriptionReadPermission.MonitoringReader,
+        displayName: 'Monitoring Reader',
+        description: 'Allows Spotto to read Azure Monitor metrics for subscription resources.',
+        requiredRoles: ['Monitoring Reader'],
+    },
+    {
+        id: SubscriptionReadPermission.LogAnalyticsDataReader,
+        displayName: 'Log Analytics Data Reader',
+        description: 'Allows Spotto to run Log Analytics and App Insights data queries.',
+        requiredRoles: ['Log Analytics Reader'],
+    },
+];
+exports.CLOUD_ACCOUNT_READ_PERMISSIONS_METADATA = [
+    {
+        id: CloudAccountReadPermission.ManagementGroupReader,
+        displayName: 'Management Group Reader',
+        description: 'Allows Spotto to read tenant management group entities.',
+        requiredRoles: ['Management Group Reader'],
+    },
+    {
+        id: CloudAccountReadPermission.ReservationsReader,
+        displayName: 'Reservations Reader',
+        description: 'Allows Spotto to read reservation resources and reservation usage artifacts.',
+        requiredRoles: ['Reader'],
+    },
+    {
+        id: CloudAccountReadPermission.SavingsPlanReader,
+        displayName: 'Savings Plan Reader',
+        description: 'Allows Spotto to read savings plan resources.',
+        requiredRoles: ['Reader'],
+    },
+    {
+        id: CloudAccountReadPermission.GraphApplicationReadAll,
+        displayName: 'Graph Application Read.All',
+        description: 'Allows Spotto to read Microsoft Graph applications and service principals.',
+        requiredRoles: ['Application.Read.All'],
+    },
+];
+//# sourceMappingURL=readPermissions.js.map

package/dist/accounts/readPermissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readPermissions.js","sourceRoot":"","sources":["../../src/accounts/readPermissions.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,0BAKX;AALD,WAAY,0BAA0B;IACpC,gDAAgD;IAChD,mGAAyB,CAAA;IACzB,mEAAmE;IACnE,+GAA+B,CAAA;AACjC,CAAC,EALW,0BAA0B,0CAA1B,0BAA0B,QAKrC;AAED;;;GAGG;AACH,IAAY,0BASX;AATD,WAAY,0BAA0B;IACpC,oDAAoD;IACpD,6GAA8B,CAAA;IAC9B,kFAAkF;IAClF,uGAA2B,CAAA;IAC3B,iDAAiD;IACjD,qGAA0B,CAAA;IAC1B,0EAA0E;IAC1E,iHAAgC,CAAA;AAClC,CAAC,EATW,0BAA0B,0CAA1B,0BAA0B,QASrC;AAsBY,QAAA,sCAAsC,GAAyC;IAC1F;QACE,EAAE,EAAE,0BAA0B,CAAC,gBAAgB;QAC/C,WAAW,EAAE,mBAAmB;QAChC,WAAW,EAAE,yEAAyE;QACtF,aAAa,EAAE,CAAC,mBAAmB,CAAC;KACrC;IACD;QACE,EAAE,EAAE,0BAA0B,CAAC,sBAAsB;QACrD,WAAW,EAAE,2BAA2B;QACxC,WAAW,EAAE,mEAAmE;QAChF,aAAa,EAAE,CAAC,sBAAsB,CAAC;KACxC;CACF,CAAC;AAEW,QAAA,uCAAuC,GAAyC;IAC3F;QACE,EAAE,EAAE,0BAA0B,CAAC,qBAAqB;QACpD,WAAW,EAAE,yBAAyB;QACtC,WAAW,EAAE,yDAAyD;QACtE,aAAa,EAAE,CAAC,yBAAyB,CAAC;KAC3C;IACD;QACE,EAAE,EAAE,0BAA0B,CAAC,kBAAkB;QACjD,WAAW,EAAE,qBAAqB;QAClC,WAAW,EAAE,8EAA8E;QAC3F,aAAa,EAAE,CAAC,QAAQ,CAAC;KAC1B;IACD;QACE,EAAE,EAAE,0BAA0B,CAAC,iBAAiB;QAChD,WAAW,EAAE,qBAAqB;QAClC,WAAW,EAAE,+CAA+C;QAC5D,aAAa,EAAE,CAAC,QAAQ,CAAC;KAC1B;IACD;QACE,EAAE,EAAE,0BAA0B,CAAC,uBAAuB;QACtD,WAAW,EAAE,4BAA4B;QACzC,WAAW,EAAE,4EAA4E;QACzF,aAAa,EAAE,CAAC,sBAAsB,CAAC;KACxC;CACF,CAAC"}

package/dist/accounts/validation.d.ts

@@ -0,0 +1,24 @@
+import type { SubscriptionAccount } from './accounts';
+export type SubscriptionValidationStatus = 'confirmed' | 'forbidden' | 'unauthorized' | 'throttled' | 'unavailable';
+export interface SubscriptionReadValidationResult {
+    subscription: SubscriptionAccount;
+    valid: boolean;
+    status: SubscriptionValidationStatus;
+    statusCode: number;
+    message?: string;
+}
+export interface CloudAccountReadAccessValidation {
+    valid: boolean;
+    subscriptions: SubscriptionAccount[];
+    subscriptionResults: SubscriptionReadValidationResult[];
+}
+export interface CloudAccountWriteAccessValidation {
+    valid: boolean;
+    subscriptions: SubscriptionAccount[];
+}
+export interface CloudAccountValidationResult {
+    valid: boolean;
+    readAccess: CloudAccountReadAccessValidation;
+    writeAccess?: CloudAccountWriteAccessValidation;
+}
+//# sourceMappingURL=validation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/accounts/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEtD,MAAM,MAAM,4BAA4B,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,GAAG,WAAW,GAAG,aAAa,CAAC;AAEpH,MAAM,WAAW,gCAAgC;IAC/C,YAAY,EAAE,mBAAmB,CAAC;IAClC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,4BAA4B,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gCAAgC;IAC/C,KAAK,EAAE,OAAO,CAAC;IACf,aAAa,EAAE,mBAAmB,EAAE,CAAC;IACrC,mBAAmB,EAAE,gCAAgC,EAAE,CAAC;CACzD;AAED,MAAM,WAAW,iCAAiC;IAChD,KAAK,EAAE,OAAO,CAAC;IACf,aAAa,EAAE,mBAAmB,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,gCAAgC,CAAC;IAC7C,WAAW,CAAC,EAAE,iCAAiC,CAAC;CACjD"}

package/dist/accounts/validation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=validation.js.map

package/dist/accounts/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/accounts/validation.ts"],"names":[],"mappings":""}

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"}