serverless-plugin-module-registry 1.0.9 → 1.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-module-registry",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "A Serverless Framework plugin that scans module registry files and stores feature mappings in DynamoDB for cross-module discovery",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,6 +48,8 @@
   },
   "files": [
     "dist/**/*",
+    "src/service.js",
+    "src/service.d.ts",
     "README.md",
     "LICENSE"
   ],

package/src/service.d.ts

@@ -0,0 +1,168 @@
+/*
+ * Module Registry Service Functions - Type Definitions
+ * -------------------------------------------
+ * TypeScript definitions for the service layer functions
+ */
+
+// Types for better developer experience
+export interface ModuleInfo {
+  moduleName: string
+  description: string
+  version: string
+  maintainer?: string
+  tags: string[]
+  apiGatewayId?: string
+  lastUpdated: string
+}
+
+export interface FeatureInfo {
+  featureName: string
+  description: string
+  version: string
+  endpoints: string[]
+  customPolicies: any[]
+  customFeature?: boolean
+  endpointCount: number
+  lastUpdated: string
+}
+
+export interface FeatureDetails extends FeatureInfo {
+  moduleName: string
+  policyCount: number
+}
+
+export interface EndpointInfo {
+  endpoint: string
+  moduleName: string
+  featureName: string
+  featureDescription: string
+  version: string
+  customFeature?: boolean
+}
+
+// New interface for custom feature creation
+export interface CreateCustomFeatureData {
+  moduleName: string
+  featureName: string
+  description: string
+  version: string
+  endpoints?: string[]
+  customPolicies?: any[]
+}
+
+/**
+ * Lists all deployed modules with basic metadata
+ */
+export declare function listAllModules(): Promise<ModuleInfo[]>
+
+/**
+ * Gets all features for a specific module
+ */
+export declare function getModuleFeatures(moduleName: string): Promise<FeatureInfo[]>
+
+/**
+ * Gets detailed information about a specific feature
+ */
+export declare function getFeatureDetails(moduleName: string, featureId: string): Promise<FeatureDetails | null>
+
+/**
+ * Gets feature details by featureId only (without knowing module name)
+ * Uses GSI2 to lookup feature directly by featureId
+ */
+export declare function getFeatureById(featureId: string): Promise<FeatureDetails | null>
+
+/**
+ * Gets module metadata (basic info without features)
+ */
+export declare function getModuleMetadata(moduleName: string): Promise<ModuleInfo | null>
+
+/**
+ * Gets endpoint summary across all modules for discovery
+ */
+export declare function getAllEndpoints(): Promise<EndpointInfo[]>
+
+/**
+ * Gets endpoint summary from non-custom features only
+ */
+export declare function getNonCustomEndpoints(): Promise<EndpointInfo[]>
+
+/**
+ * Creates a new custom feature in the module registry
+ */
+export declare function createCustomFeature(featureData: CreateCustomFeatureData): Promise<FeatureInfo>
+
+// =============================================================================
+// ABAC (Attribute-Based Access Control) Functions
+// =============================================================================
+
+export interface AbacGenerationOptions {
+  region?: string
+  accountId?: string
+  apiId?: string
+  selectedFeatures?: SelectedFeature[]
+}
+
+export interface AbacPolicyDocument {
+  Version: string
+  Statement: Array<{
+    Sid: string
+    Effect: 'Allow' | 'Deny'
+    Action: string | string[]
+    Resource: string | string[]
+    Condition: {
+      StringLike: {
+        [key: string]: string
+      }
+    }
+  }>
+}
+
+export interface AbacTag {
+  Key: string
+  Value: string
+}
+
+export interface SelectedFeature {
+  moduleName: string
+  featureName: string
+}
+
+/**
+ * Generates a single module-level managed policy with ABAC conditions
+ */
+export declare function generateModuleAbacPolicy(
+  moduleName: string, 
+  options?: AbacGenerationOptions
+): Promise<AbacPolicyDocument>
+
+/**
+ * Generates ABAC policy documents for all modules
+ */
+export declare function generateAllModuleAbacPolicies(
+  options?: AbacGenerationOptions
+): Promise<Record<string, AbacPolicyDocument>>
+
+/**
+ * Creates resource tags for a role based on selected features
+ */
+export declare function generateAbacTags(
+  selectedFeatures: SelectedFeature[]
+): Promise<AbacTag[]>
+
+/**
+ * Gets required managed policy ARNs for a set of selected features
+ */
+export declare function getRequiredModulePolicyArns(
+  selectedFeatures: SelectedFeature[], 
+  accountId: string,
+  policyPrefix: string
+): Promise<string[]>
+
+/**
+ * Creates a structured logger for module registry operations
+ */
+export declare function createModuleRegistryLogger(context: string): {
+  info: (message: string, data?: any) => void
+  warn: (message: string, data?: any) => void
+  error: (message: string, error?: any) => void
+}