@pipeline-builder/api-core 3.1.0

package/openapi.yaml

@@ -0,0 +1,292 @@
+openapi: 3.0.3
+info:
+  title: Pipeline API Common Types
+  description: Shared type definitions and schemas for Pipeline API microservices
+  version: 0.1.0
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: JWT access token
+
+  schemas:
+    # Standard Response Types
+    SuccessResponse:
+      type: object
+      required:
+        - success
+        - statusCode
+      properties:
+        success:
+          type: boolean
+          enum: [true]
+        statusCode:
+          type: integer
+          example: 200
+        data:
+          type: object
+        message:
+          type: string
+
+    ErrorResponse:
+      type: object
+      required:
+        - success
+        - statusCode
+        - message
+      properties:
+        success:
+          type: boolean
+          enum: [false]
+        statusCode:
+          type: integer
+          example: 400
+        message:
+          type: string
+        code:
+          $ref: '#/components/schemas/ErrorCode'
+        details:
+          type: object
+
+    # Error Codes
+    ErrorCode:
+      type: string
+      enum:
+        - UNAUTHORIZED
+        - TOKEN_EXPIRED
+        - TOKEN_INVALID
+        - TOKEN_MISSING
+        - FORBIDDEN
+        - INSUFFICIENT_PERMISSIONS
+        - ORG_MISMATCH
+        - NOT_FOUND
+        - RESOURCE_NOT_FOUND
+        - ORG_NOT_FOUND
+        - VALIDATION_ERROR
+        - INVALID_INPUT
+        - MISSING_REQUIRED_FIELD
+        - INVALID_FORMAT
+        - QUOTA_EXCEEDED
+        - RATE_LIMIT_EXCEEDED
+        - PLUGINS_QUOTA_EXCEEDED
+        - PIPELINES_QUOTA_EXCEEDED
+        - API_CALLS_QUOTA_EXCEEDED
+        - CONFLICT
+        - ALREADY_EXISTS
+        - DUPLICATE_ENTRY
+        - INTERNAL_ERROR
+        - DATABASE_ERROR
+        - SERVICE_UNAVAILABLE
+        - EXTERNAL_SERVICE_ERROR
+
+    # Quota Types
+    QuotaType:
+      type: string
+      enum:
+        - plugins
+        - pipelines
+        - apiCalls
+
+    QuotaInfo:
+      type: object
+      required:
+        - type
+        - limit
+        - used
+        - remaining
+      properties:
+        type:
+          $ref: '#/components/schemas/QuotaType'
+        limit:
+          type: integer
+          description: Maximum quota limit (-1 for unlimited)
+          example: 100
+        used:
+          type: integer
+          description: Current usage count
+          example: 42
+        remaining:
+          type: integer
+          description: Remaining quota (-1 for unlimited)
+          example: 58
+
+    QuotaExceededResponse:
+      allOf:
+        - $ref: '#/components/schemas/ErrorResponse'
+        - type: object
+          properties:
+            quota:
+              $ref: '#/components/schemas/QuotaInfo'
+
+    # Health Check
+    HealthCheckResponse:
+      type: object
+      required:
+        - status
+        - service
+        - timestamp
+        - uptime
+      properties:
+        status:
+          type: string
+          enum: [healthy, unhealthy]
+        service:
+          type: string
+          example: get-plugin
+        timestamp:
+          type: string
+          format: date-time
+        uptime:
+          type: integer
+          description: Uptime in seconds
+        version:
+          type: string
+        dependencies:
+          type: object
+          additionalProperties:
+            type: string
+            enum: [connected, disconnected, unknown]
+
+    # JWT Payload
+    JwtPayload:
+      type: object
+      required:
+        - sub
+        - username
+        - email
+        - role
+        - type
+      properties:
+        sub:
+          type: string
+          description: User ID (subject)
+        username:
+          type: string
+        email:
+          type: string
+          format: email
+        role:
+          type: string
+          enum: [user, admin]
+        organizationId:
+          type: string
+        organizationName:
+          type: string
+        type:
+          type: string
+          enum: [access, refresh]
+        iat:
+          type: integer
+          description: Issued at timestamp
+        exp:
+          type: integer
+          description: Expiration timestamp
+
+  headers:
+    X-Quota-Limit:
+      description: Maximum quota limit
+      schema:
+        type: integer
+    X-Quota-Used:
+      description: Current usage count
+      schema:
+        type: integer
+    X-Quota-Remaining:
+      description: Remaining quota
+      schema:
+        type: integer
+    X-Quota-Reset:
+      description: ISO timestamp when quota resets
+      schema:
+        type: string
+        format: date-time
+    Retry-After:
+      description: Seconds until quota resets
+      schema:
+        type: integer
+
+  responses:
+    Unauthorized:
+      description: Authentication required
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ErrorResponse'
+          example:
+            success: false
+            statusCode: 401
+            message: Authorization header required
+            code: TOKEN_MISSING
+
+    Forbidden:
+      description: Insufficient permissions
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ErrorResponse'
+          example:
+            success: false
+            statusCode: 403
+            message: Admin access required
+            code: INSUFFICIENT_PERMISSIONS
+
+    NotFound:
+      description: Resource not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ErrorResponse'
+          example:
+            success: false
+            statusCode: 404
+            message: Resource not found
+            code: NOT_FOUND
+
+    QuotaExceeded:
+      description: Quota exceeded
+      headers:
+        Retry-After:
+          $ref: '#/components/headers/Retry-After'
+        X-Quota-Limit:
+          $ref: '#/components/headers/X-Quota-Limit'
+        X-Quota-Used:
+          $ref: '#/components/headers/X-Quota-Used'
+        X-Quota-Remaining:
+          $ref: '#/components/headers/X-Quota-Remaining'
+        X-Quota-Reset:
+          $ref: '#/components/headers/X-Quota-Reset'
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/QuotaExceededResponse'
+          example:
+            success: false
+            statusCode: 429
+            message: API call quota exceeded (10000/10000). Please try again later.
+            code: QUOTA_EXCEEDED
+            quota:
+              type: apiCalls
+              limit: 10000
+              used: 10000
+              remaining: 0
+
+    InternalError:
+      description: Internal server error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ErrorResponse'
+          example:
+            success: false
+            statusCode: 500
+            message: An unexpected error occurred
+            code: INTERNAL_ERROR
+
+security:
+  - bearerAuth: []

package/package.json

@@ -0,0 +1,127 @@
+{
+  "name": "@pipeline-builder/api-core",
+  "description": "Core server-side utilities (auth middleware, response helpers, error codes, quota service, HTTP client, logging, AI provider catalog) shared by every Pipeline Builder backend service.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mwashburn160/pipeline-builder.git"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^2",
+    "@types/express": "5.0.6",
+    "@types/jest": "^30.0.0",
+    "@types/jsonwebtoken": "9.0.10",
+    "@types/node": "25.3.0",
+    "@typescript-eslint/eslint-plugin": "^8",
+    "@typescript-eslint/parser": "^8",
+    "eslint": "^9",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "jest": "^30.2.0",
+    "jest-junit": "^16",
+    "ts-jest": "^29.4.6",
+    "typescript": "5.9.3"
+  },
+  "dependencies": {
+    "@asteasolutions/zod-to-openapi": "8.4.0",
+    "express": "5.2.1",
+    "jsonwebtoken": "9.0.3",
+    "winston": "3.19.0",
+    "zod": "4.3.6"
+  },
+  "keywords": [
+    "aws",
+    "codepipeline",
+    "codebuild",
+    "cicd",
+    "ci-cd",
+    "devops",
+    "cdk",
+    "aws-cdk",
+    "cloudformation",
+    "pipeline",
+    "pipeline-as-code",
+    "containerized",
+    "docker",
+    "kubernetes",
+    "plugins",
+    "typescript",
+    "self-service",
+    "multi-tenant",
+    "compliance",
+    "automation",
+    "infrastructure-as-code",
+    "iac",
+    "cli"
+  ],
+  "engines": {
+    "node": ">= 24.14.0"
+  },
+  "main": "lib/index.js",
+  "license": "Apache-2.0",
+  "homepage": "https://mwashburn160.github.io/pipeline-builder/",
+  "version": "3.1.0",
+  "bugs": {
+    "url": "https://github.com/mwashburn160/pipeline-builder/issues"
+  },
+  "jest": {
+    "coverageProvider": "v8",
+    "testMatch": [
+      "<rootDir>/@(src|test)/**/*(*.)@(spec|test).ts?(x)",
+      "<rootDir>/@(src|test)/**/__tests__/**/*.ts?(x)"
+    ],
+    "clearMocks": true,
+    "collectCoverage": true,
+    "coverageReporters": [
+      "json",
+      "lcov",
+      "clover",
+      "cobertura",
+      "text"
+    ],
+    "coverageDirectory": "coverage",
+    "coveragePathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "watchPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "reporters": [
+      "default",
+      [
+        "jest-junit",
+        {
+          "outputDirectory": "test-reports"
+        }
+      ]
+    ],
+    "transform": {
+      "^.+\\.[t]sx?$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.dev.json"
+        }
+      ]
+    },
+    "moduleNameMapper": {
+      "^uuid$": "<rootDir>/../../jest-uuid-stub.js"
+    }
+  },
+  "types": "lib/index.d.ts",
+  "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"pnpm dlx projen\".",
+  "scripts": {
+    "build": "pnpm dlx projen build",
+    "compile": "pnpm dlx projen compile",
+    "default": "pnpm dlx projen default",
+    "eslint": "pnpm dlx projen eslint",
+    "package": "pnpm dlx projen package",
+    "post-compile": "pnpm dlx projen post-compile",
+    "pre-compile": "pnpm dlx projen pre-compile",
+    "test": "pnpm dlx projen test",
+    "test:watch": "pnpm dlx projen test:watch",
+    "watch": "pnpm dlx projen watch",
+    "projen": "pnpm dlx projen"
+  }
+}