@igstack/app-catalog-backend-core 0.0.1

package/src/types/common/app/ui/appUiTypes.ts

@@ -0,0 +1,12 @@
+import type { Tag } from '../../sharedTypes'
+
+export interface EhAppPageIndexed {
+  slug: string
+  displayName: string
+  url: string
+  tags?: Array<Tag>
+}
+
+export interface EhAppUiIndexed {
+  pages: Array<EhAppPageIndexed>
+}

package/src/types/common/appCatalogTypes.ts

@@ -0,0 +1,65 @@
+/**
+ * App Catalog Types - Universal Software Access Request Catalog
+ *
+ * These types define a standardized catalog of software applications and their
+ * access methods. The typing system is designed to be universal across companies,
+ * abstracting away specific tools (Jira, Slack, etc.) into generic categories.
+ */
+
+import type { AppAccessRequest, ApprovalMethod } from './approvalMethodTypes'
+
+// ============================================================================
+// APP CATALOG TYPES
+// ============================================================================
+
+/**
+ * Application entry in the catalog
+ */
+export interface AppForCatalog {
+  id: string
+  slug: string
+  displayName: string
+  description?: string
+  teams?: Array<string>
+  accessRequest?: AppAccessRequest
+  notes?: string
+  tags?: Array<string>
+  appUrl?: string
+  links?: Array<{ url: string; title?: string }>
+  iconName?: string // Optional icon identifier for display
+  screenshotIds?: Array<string>
+}
+
+// Derived catalog data returned by backend
+export interface AppCategory {
+  id: string
+  name: string
+}
+
+export interface GroupingTagDefinition {
+  prefix: string
+  displayName: string
+  description: string
+  values: Array<GroupingTagValue>
+}
+
+type DistributiveOmit<T, TKey extends keyof any> = T extends any
+  ? Omit<T, TKey>
+  : never
+
+export type AppApprovalMethod = DistributiveOmit<
+  ApprovalMethod,
+  'createdAt' | 'updatedAt'
+>
+
+export interface GroupingTagValue {
+  value: string
+  displayName: string
+  description: string
+}
+
+export interface AppCatalogData {
+  apps: Array<AppForCatalog>
+  tagsDefinitions: Array<GroupingTagDefinition>
+  approvalMethods: Array<AppApprovalMethod>
+}

package/src/types/common/approvalMethodTypes.ts

@@ -0,0 +1,149 @@
+/**
+ * Approval Method Types
+ *
+ * Global approval method templates that apps can link to.
+ * Each method has a type (service, personTeam, custom) with type-specific config.
+ */
+
+// ============================================================================
+// APPROVAL METHOD TYPES (Global Templates)
+// ============================================================================
+
+export type ApprovalMethodType = 'service' | 'personTeam' | 'custom'
+
+/**
+ * Contact for reaching out (not necessarily the approver)
+ */
+export interface ReachOutContact {
+  displayName: string
+  contact: string // email, slack handle, etc.
+}
+
+/**
+ * Service type config - for bots, ticketing systems, self-service portals
+ */
+export interface ServiceConfig {
+  url?: string // Service URL (clickable in UI)
+  icon?: string // Icon identifier
+}
+
+/**
+ * Person/Team type config - for human approvers
+ */
+export interface PersonTeamConfig {
+  reachOutContacts?: Array<ReachOutContact>
+}
+
+/**
+ * Custom type config - generic, no additional fields
+ */
+export interface CustomConfig {
+  // No additional fields
+}
+
+/**
+ * Union of all config types
+ */
+export type ApprovalMethodConfig =
+  | ServiceConfig
+  | PersonTeamConfig
+  | CustomConfig
+
+/**
+ * Approval Method - stored in DbApprovalMethod
+ */
+// export interface ApprovalMethod {
+//   slug: string
+//   type: ApprovalMethodType
+//   displayName: string
+//   config?: ApprovalMethodConfig
+//   createdAt?: Date
+//   updatedAt?: Date
+// }
+
+export type ApprovalMethod = {
+  slug: string
+  displayName: string
+  createdAt?: Date
+  updatedAt?: Date
+} & (
+  | {
+      type: 'service'
+      config: ServiceConfig
+    }
+  | {
+      type: 'personTeam'
+      config: PersonTeamConfig
+    }
+  | {
+      type: 'custom'
+      config: CustomConfig
+    }
+)
+
+// ============================================================================
+// PER-APP APPROVAL DETAILS
+// ============================================================================
+
+/**
+ * Role that can be requested for an app
+ */
+export interface AppRole {
+  displayName: string
+  description?: string
+  adminNotes?: string
+}
+
+/**
+ * Approver contact (person who approves, may differ from reach-out contact)
+ */
+export interface ApproverContact {
+  displayName: string
+  contact?: string
+}
+
+/**
+ * URL link with optional label
+ */
+export interface ApprovalUrl {
+  label?: string
+  url: string
+}
+
+/**
+ * Per-app approval details - stored as JSON in DbAppForCatalog
+ * All comment/text-like strings are markdown
+ */
+export interface AppAccessRequest {
+  approvalMethodId: string // FK to DbApprovalMethod
+
+  // Common fields (all types) - markdown text
+  comments?: string
+  requestPrompt?: string
+  postApprovalInstructions?: string
+
+  // Lists
+  roles?: Array<AppRole>
+  approvers?: Array<ApproverContact>
+  urls?: Array<ApprovalUrl>
+
+  // Type-specific (Person/Team only)
+  whoToReachOut?: string // markdown
+}
+
+// ============================================================================
+// INPUT TYPES FOR API
+// ============================================================================
+
+export interface CreateApprovalMethodInput {
+  type: ApprovalMethodType
+  displayName: string
+  config?: ApprovalMethodConfig
+}
+
+export interface UpdateApprovalMethodInput {
+  id: string
+  type?: ApprovalMethodType
+  displayName?: string
+  config?: ApprovalMethodConfig
+}

package/src/types/common/env/envTypes.ts

@@ -0,0 +1,7 @@
+import type { EhMetaDictionary } from '../sharedTypes'
+
+export interface EhEnvIndexed {
+  slug: string
+  displayName: string
+  meta?: EhMetaDictionary
+}

package/src/types/common/resourceTypes.ts

@@ -0,0 +1,8 @@
+/**
+ * Resources like kafka topics, database tables, etc.
+ */
+export interface EhResourceIndexed {
+  slug: string
+  displayName: string
+  defaultFixedValues?: Array<string>
+}

package/src/types/common/sharedTypes.ts

@@ -0,0 +1,5 @@
+export interface EhMetaDictionary {
+  [key: string]: string | null | Record<string, string | null>
+}
+
+export type Tag = string

package/src/types/index.ts

@@ -0,0 +1,21 @@
+// Export all common types
+export * from './common/sharedTypes.js'
+export * from './common/resourceTypes.js'
+export * from './common/appCatalogTypes.js'
+export * from './common/approvalMethodTypes.js'
+export * from './common/env/envTypes.js'
+export * from './common/app/appTypes.js'
+export * from './common/app/ui/appUiTypes.js'
+
+// Main API interfaces
+export * from './backend/api.js'
+
+// Common types
+export * from './backend/common.js'
+// Data source types
+export * from './backend/dataSources.js'
+// Company specific backend types
+export * from './backend/companySpecificBackend.js'
+
+// Deployment and version types
+export * from './backend/deployments.js'