@igstack/app-catalog-shared-core 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Igor Golovin
+
+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/dist/esm/__tests__/dummy.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/appCatalogTypes.d.ts

@@ -0,0 +1,127 @@
+/**
+ * App Catalog Types - Universal Software Access Request Catalog
+ *
+ * These types define a standardized catalog of software applications and their
+ * access/approval methods. The typing system is designed to be universal across companies.
+ */
+/**
+ * Person who can approve access requests
+ */
+export interface Person {
+    firstName: string;
+    lastName: string;
+    email: string;
+    slack?: string;
+}
+/**
+ * Approval type for UI selection
+ */
+export type ApprovalType = 'none' | 'service' | 'person' | 'other' | 'unknown';
+/**
+ * Approval type options for UI display
+ */
+export declare const APPROVAL_TYPES: ReadonlyArray<{
+    value: ApprovalType;
+    label: string;
+}>;
+/**
+ * Common fields for all approval method types
+ */
+export interface BaseApprovalMethod {
+    comment?: string;
+    roles?: Array<AppRole>;
+    approvalPolicy?: string;
+    postApprovalInstructions?: string;
+    seeMoreUrls?: Array<string>;
+}
+/**
+ * Service-based approval (bot or ticketing system)
+ */
+export interface ServiceApprovalMethod extends BaseApprovalMethod {
+    type: 'service';
+    serviceId: string;
+    url?: string;
+    prompt?: string;
+    requestFormTemplate?: string;
+}
+/**
+ * Person-based approval
+ */
+export interface PersonApprovalMethod extends BaseApprovalMethod {
+    type: 'person';
+    person: Person;
+    url?: string;
+    additionalInfo?: string;
+}
+/**
+ * Other/custom approval method (TBC)
+ */
+export interface OtherApprovalMethod extends BaseApprovalMethod {
+    type: 'other';
+    description: string;
+}
+/**
+ * Unknown approval method
+ */
+export interface UnknownApprovalMethod extends BaseApprovalMethod {
+    type: 'unknown';
+}
+/**
+ * No approval needed
+ */
+export interface NoneApprovalMethod {
+    type: 'none';
+}
+/**
+ * Union of all approval method types
+ */
+export type ApprovalMethod = NoneApprovalMethod | ServiceApprovalMethod | PersonApprovalMethod | OtherApprovalMethod | UnknownApprovalMethod;
+/**
+ * Service approval configuration - unified bot and ticketing systems
+ */
+export interface ServiceApproval {
+    id: string;
+    name: string;
+    serviceType: 'bot' | 'ticket';
+    platform?: 'slack' | 'teams' | 'web' | 'other';
+    system?: 'jira' | 'servicenow' | 'zendesk' | 'freshdesk' | 'other';
+    baseUrl?: string;
+    url?: string;
+    icon?: string;
+    instructions?: string;
+}
+/**
+ * Role that can be requested for an app
+ */
+export interface AppRole {
+    name: string;
+    description?: string;
+}
+/**
+ * Application entry in the catalog
+ */
+export interface AppForCatalog {
+    id: string;
+    slug: string;
+    displayName: string;
+    description?: string;
+    approvalMethod?: ApprovalMethod;
+    teams?: Array<string>;
+    notes?: string;
+    tags?: Array<string>;
+    appUrl?: string;
+    links?: Array<{
+        url: string;
+        title?: string;
+    }>;
+    iconName?: string;
+    screenshotIds?: Array<string>;
+}
+export interface AppCategory {
+    id: string;
+    name: string;
+}
+export interface AppCatalogData {
+    apps: Array<AppForCatalog>;
+    categories: Array<AppCategory>;
+}

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+export * from './nullToUndefined.js';

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+import { nullToUndefined, undefinedToNull } from "./nullToUndefined.js";
+export {
+  nullToUndefined,
+  undefinedToNull
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/esm/nullToUndefined.d.ts

@@ -0,0 +1,21 @@
+import { Primitive } from 'type-fest';
+export type NullToUndefined<T> = T extends null ? undefined : T extends Primitive | Function | Date | RegExp ? T : T extends Array<infer U> ? Array<NullToUndefined<U>> : T extends Map<infer K, infer V> ? Map<K, NullToUndefined<V>> : T extends Set<infer U> ? Set<NullToUndefined<U>> : T extends object ? {
+    [K in keyof T]: NullToUndefined<T[K]>;
+} : unknown;
+export type UndefinedToNull<T> = T extends undefined ? null : T extends Primitive | Function | Date | RegExp ? T : T extends Array<infer U> ? Array<UndefinedToNull<U>> : T extends Map<infer K, infer V> ? Map<K, UndefinedToNull<V>> : T extends Set<infer U> ? Set<NullToUndefined<U>> : T extends object ? {
+    [K in keyof T]: UndefinedToNull<T[K]>;
+} : unknown;
+/**
+ * Recursively converts all null values to undefined.
+ *
+ * @param obj object to convert
+ * @returns a copy of the object with all its null values converted to undefined
+ */
+export declare function nullToUndefined<T>(obj: T): NullToUndefined<T>;
+/**
+ * Recursively converts all undefined values to null.
+ *
+ * @param obj object to convert
+ * @returns a copy of the object with all its undefined values converted to null
+ */
+export declare function undefinedToNull<T>(obj: T): UndefinedToNull<T>;

package/dist/esm/nullToUndefined.js

@@ -0,0 +1,41 @@
+function _nullToUndefined(obj) {
+  if (obj === null) {
+    return void 0;
+  }
+  if (typeof obj === "object") {
+    if (obj instanceof Map) {
+      obj.forEach((value, key) => obj.set(key, _nullToUndefined(value)));
+    } else {
+      for (const key in obj) {
+        obj[key] = _nullToUndefined(obj[key]);
+      }
+    }
+  }
+  return obj;
+}
+function nullToUndefined(obj) {
+  return _nullToUndefined(structuredClone(obj));
+}
+function _undefinedToNull(obj) {
+  if (obj === void 0) {
+    return null;
+  }
+  if (typeof obj === "object") {
+    if (obj instanceof Map) {
+      obj.forEach((value, key) => obj.set(key, _undefinedToNull(value)));
+    } else {
+      for (const key in obj) {
+        obj[key] = _undefinedToNull(obj[key]);
+      }
+    }
+  }
+  return obj;
+}
+function undefinedToNull(obj) {
+  return _undefinedToNull(structuredClone(obj));
+}
+export {
+  nullToUndefined,
+  undefinedToNull
+};
+//# sourceMappingURL=nullToUndefined.js.map

package/dist/esm/nullToUndefined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nullToUndefined.js","sources":["../../src/nullToUndefined.ts"],"sourcesContent":["import type { Primitive } from 'type-fest'\n\n/*\n  Taken from https://gist.github.com/tkrotoff/a6baf96eb6b61b445a9142e5555511a0\n * [Generic way to convert all instances of null to undefined in TypeScript](https://stackoverflow.com/q/50374869)\n *\n * This only works with JS objects hence the file name *Object*Values\n *\n * [\"I intend to stop using `null` in my JS code in favor of `undefined`\"](https://github.com/sindresorhus/meta/discussions/7)\n * [Proposal: NullToUndefined and UndefinedToNull](https://github.com/sindresorhus/type-fest/issues/603)\n *\n * Types implementation inspired by:\n * - https://github.com/sindresorhus/type-fest/blob/v2.12.2/source/delimiter-cased-properties-deep.d.ts\n * - https://github.com/sindresorhus/type-fest/blob/v2.12.2/source/readonly-deep.d.ts\n *\n * https://gist.github.com/tkrotoff/a6baf96eb6b61b445a9142e5555511a0\n */\nexport type NullToUndefined<T> = T extends null\n  ? undefined\n  : T extends Primitive | Function | Date | RegExp\n    ? T\n    : T extends Array<infer U>\n      ? Array<NullToUndefined<U>>\n      : T extends Map<infer K, infer V>\n        ? Map<K, NullToUndefined<V>>\n        : T extends Set<infer U>\n          ? Set<NullToUndefined<U>>\n          : T extends object\n            ? { [K in keyof T]: NullToUndefined<T[K]> }\n            : unknown\n\nexport type UndefinedToNull<T> = T extends undefined\n  ? null\n  : T extends Primitive | Function | Date | RegExp\n    ? T\n    : T extends Array<infer U>\n      ? Array<UndefinedToNull<U>>\n      : T extends Map<infer K, infer V>\n        ? Map<K, UndefinedToNull<V>>\n        : T extends Set<infer U>\n          ? Set<NullToUndefined<U>>\n          : T extends object\n            ? { [K in keyof T]: UndefinedToNull<T[K]> }\n            : unknown\n\nfunction _nullToUndefined<T>(obj: T): NullToUndefined<T> {\n  if (obj === null) {\n    return undefined as any\n  }\n\n  if (typeof obj === 'object') {\n    if (obj instanceof Map) {\n      obj.forEach((value, key) => obj.set(key, _nullToUndefined(value)))\n    } else {\n      for (const key in obj) {\n        obj[key] = _nullToUndefined(obj[key]) as any\n      }\n    }\n  }\n\n  return obj as any\n}\n\n/**\n * Recursively converts all null values to undefined.\n *\n * @param obj object to convert\n * @returns a copy of the object with all its null values converted to undefined\n */\nexport function nullToUndefined<\n  T,\n  // Can cause: \"Type instantiation is excessively deep and possibly infinite.\"\n  // extends Jsonifiable\n>(obj: T) {\n  return _nullToUndefined(structuredClone(obj))\n}\n\nfunction _undefinedToNull<T>(obj: T): UndefinedToNull<T> {\n  if (obj === undefined) {\n    return null as any\n  }\n\n  if (typeof obj === 'object') {\n    if (obj instanceof Map) {\n      obj.forEach((value, key) => obj.set(key, _undefinedToNull(value)))\n    } else {\n      for (const key in obj) {\n        obj[key] = _undefinedToNull(obj[key]) as any\n      }\n    }\n  }\n\n  return obj as any\n}\n\n/**\n * Recursively converts all undefined values to null.\n *\n * @param obj object to convert\n * @returns a copy of the object with all its undefined values converted to null\n */\nexport function undefinedToNull<\n  T,\n  // Can cause: \"Type instantiation is excessively deep and possibly infinite.\"\n  // extends Jsonifiable\n>(obj: T) {\n  return _undefinedToNull(structuredClone(obj))\n}\n"],"names":[],"mappings":"AA6CA,SAAS,iBAAoB,KAA4B;AACvD,MAAI,QAAQ,MAAM;AAChB,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,QAAQ,UAAU;AAC3B,QAAI,eAAe,KAAK;AACtB,UAAI,QAAQ,CAAC,OAAO,QAAQ,IAAI,IAAI,KAAK,iBAAiB,KAAK,CAAC,CAAC;AAAA,IACnE,OAAO;AACL,iBAAW,OAAO,KAAK;AACrB,YAAI,GAAG,IAAI,iBAAiB,IAAI,GAAG,CAAC;AAAA,MACtC;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;AAQO,SAAS,gBAId,KAAQ;AACR,SAAO,iBAAiB,gBAAgB,GAAG,CAAC;AAC9C;AAEA,SAAS,iBAAoB,KAA4B;AACvD,MAAI,QAAQ,QAAW;AACrB,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,QAAQ,UAAU;AAC3B,QAAI,eAAe,KAAK;AACtB,UAAI,QAAQ,CAAC,OAAO,QAAQ,IAAI,IAAI,KAAK,iBAAiB,KAAK,CAAC,CAAC;AAAA,IACnE,OAAO;AACL,iBAAW,OAAO,KAAK;AACrB,YAAI,GAAG,IAAI,iBAAiB,IAAI,GAAG,CAAC;AAAA,MACtC;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;AAQO,SAAS,gBAId,KAAQ;AACR,SAAO,iBAAiB,gBAAgB,GAAG,CAAC;AAC9C;"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@igstack/app-catalog-shared-core",
+  "version": "0.0.1",
+  "description": "Shared core utilities for App Catalog",
+  "homepage": "https://github.com/lislon/app-catalog",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lislon/app-catalog.git",
+    "directory": "packages/shared-core"
+  },
+  "license": "MIT",
+  "author": "Igor Golovin",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "my-custom-condition": "./src/index.ts",
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "eta": "^3.5.0",
+    "type-fest": "^5.4.4"
+  },
+  "devDependencies": {
+    "@tanstack/vite-config": "^0.4.3",
+    "@types/node": "^24.3.0",
+    "esbuild": "^0.25.5",
+    "tsx": "^4.19.4",
+    "typescript": "5.9.2"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "build": "vite build",
+    "clean": "premove ./dist ./coverage ./dist-ts",
+    "compile": "tsc --build",
+    "dev": "tsx watch src/index.ts",
+    "test:eslint": "eslint ./src",
+    "test:unit": "vitest",
+    "test:unit:dev": "pnpm run test:unit --watch"
+  }
+}

package/src/__tests__/dummy.test.ts

@@ -0,0 +1,7 @@
+import { describe, expect, it } from 'vitest'
+
+describe('dummy', () => {
+  it('always passes', () => {
+    expect(true).toBe(true)
+  })
+})

package/src/appCatalogTypes.ts

@@ -0,0 +1,173 @@
+/**
+ * App Catalog Types - Universal Software Access Request Catalog
+ *
+ * These types define a standardized catalog of software applications and their
+ * access/approval methods. The typing system is designed to be universal across companies.
+ */
+
+// ============================================================================
+// PERSON TYPE
+// ============================================================================
+
+/**
+ * Person who can approve access requests
+ */
+export interface Person {
+  firstName: string
+  lastName: string
+  email: string
+  slack?: string
+}
+
+// ============================================================================
+// APPROVAL METHOD TYPES
+// ============================================================================
+
+/**
+ * Approval type for UI selection
+ */
+export type ApprovalType = 'none' | 'service' | 'person' | 'other' | 'unknown'
+
+/**
+ * Approval type options for UI display
+ */
+export const APPROVAL_TYPES: ReadonlyArray<{
+  value: ApprovalType
+  label: string
+}> = [
+  { value: 'none', label: 'None' },
+  { value: 'service', label: 'Service' },
+  { value: 'person', label: 'Person' },
+  { value: 'other', label: 'Other' },
+  { value: 'unknown', label: 'Unknown' },
+]
+
+/**
+ * Common fields for all approval method types
+ */
+export interface BaseApprovalMethod {
+  comment?: string
+  roles?: Array<AppRole>
+  approvalPolicy?: string
+  postApprovalInstructions?: string
+  seeMoreUrls?: Array<string>
+}
+
+/**
+ * Service-based approval (bot or ticketing system)
+ */
+export interface ServiceApprovalMethod extends BaseApprovalMethod {
+  type: 'service'
+  serviceId: string // References a specific service (bot or ticket system)
+  url?: string
+  prompt?: string // For bots
+  requestFormTemplate?: string // For ticket systems
+}
+
+/**
+ * Person-based approval
+ */
+export interface PersonApprovalMethod extends BaseApprovalMethod {
+  type: 'person'
+  person: Person // Person details embedded directly
+  url?: string
+  additionalInfo?: string
+}
+
+/**
+ * Other/custom approval method (TBC)
+ */
+export interface OtherApprovalMethod extends BaseApprovalMethod {
+  type: 'other'
+  description: string // Free-form text description
+}
+
+/**
+ * Unknown approval method
+ */
+export interface UnknownApprovalMethod extends BaseApprovalMethod {
+  type: 'unknown'
+}
+
+/**
+ * No approval needed
+ */
+export interface NoneApprovalMethod {
+  type: 'none'
+}
+
+/**
+ * Union of all approval method types
+ */
+export type ApprovalMethod =
+  | NoneApprovalMethod
+  | ServiceApprovalMethod
+  | PersonApprovalMethod
+  | OtherApprovalMethod
+  | UnknownApprovalMethod
+
+// ============================================================================
+// SERVICE APPROVAL TYPES (BOT & TICKETING)
+// ============================================================================
+
+/**
+ * Service approval configuration - unified bot and ticketing systems
+ */
+export interface ServiceApproval {
+  id: string
+  name: string
+  serviceType: 'bot' | 'ticket'
+  // Bot-specific fields
+  platform?: 'slack' | 'teams' | 'web' | 'other'
+  // Ticket-specific fields
+  system?: 'jira' | 'servicenow' | 'zendesk' | 'freshdesk' | 'other'
+  baseUrl?: string
+  url?: string
+  icon?: string
+  instructions?: string
+}
+
+// ============================================================================
+// ROLE TYPE
+// ============================================================================
+
+/**
+ * Role that can be requested for an app
+ */
+export interface AppRole {
+  name: string
+  description?: string
+}
+
+// ============================================================================
+// APP CATALOG TYPES
+// ============================================================================
+
+/**
+ * Application entry in the catalog
+ */
+export interface AppForCatalog {
+  id: string
+  slug: string
+  displayName: string
+  description?: string
+  approvalMethod?: ApprovalMethod
+  teams?: Array<string> // Teams that use this app
+  notes?: string
+  tags?: Array<string>
+  appUrl?: string
+  links?: Array<{ url: string; title?: string }>
+  iconName?: string
+  screenshotIds?: Array<string>
+}
+
+// Derived catalog data returned by backend
+export interface AppCategory {
+  id: string
+  name: string
+}
+
+export interface AppCatalogData {
+  apps: Array<AppForCatalog>
+  categories: Array<AppCategory>
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './nullToUndefined'

package/src/nullToUndefined.ts

@@ -0,0 +1,108 @@
+import type { Primitive } from 'type-fest'
+
+/*
+  Taken from https://gist.github.com/tkrotoff/a6baf96eb6b61b445a9142e5555511a0
+ * [Generic way to convert all instances of null to undefined in TypeScript](https://stackoverflow.com/q/50374869)
+ *
+ * This only works with JS objects hence the file name *Object*Values
+ *
+ * ["I intend to stop using `null` in my JS code in favor of `undefined`"](https://github.com/sindresorhus/meta/discussions/7)
+ * [Proposal: NullToUndefined and UndefinedToNull](https://github.com/sindresorhus/type-fest/issues/603)
+ *
+ * Types implementation inspired by:
+ * - https://github.com/sindresorhus/type-fest/blob/v2.12.2/source/delimiter-cased-properties-deep.d.ts
+ * - https://github.com/sindresorhus/type-fest/blob/v2.12.2/source/readonly-deep.d.ts
+ *
+ * https://gist.github.com/tkrotoff/a6baf96eb6b61b445a9142e5555511a0
+ */
+export type NullToUndefined<T> = T extends null
+  ? undefined
+  : T extends Primitive | Function | Date | RegExp
+    ? T
+    : T extends Array<infer U>
+      ? Array<NullToUndefined<U>>
+      : T extends Map<infer K, infer V>
+        ? Map<K, NullToUndefined<V>>
+        : T extends Set<infer U>
+          ? Set<NullToUndefined<U>>
+          : T extends object
+            ? { [K in keyof T]: NullToUndefined<T[K]> }
+            : unknown
+
+export type UndefinedToNull<T> = T extends undefined
+  ? null
+  : T extends Primitive | Function | Date | RegExp
+    ? T
+    : T extends Array<infer U>
+      ? Array<UndefinedToNull<U>>
+      : T extends Map<infer K, infer V>
+        ? Map<K, UndefinedToNull<V>>
+        : T extends Set<infer U>
+          ? Set<NullToUndefined<U>>
+          : T extends object
+            ? { [K in keyof T]: UndefinedToNull<T[K]> }
+            : unknown
+
+function _nullToUndefined<T>(obj: T): NullToUndefined<T> {
+  if (obj === null) {
+    return undefined as any
+  }
+
+  if (typeof obj === 'object') {
+    if (obj instanceof Map) {
+      obj.forEach((value, key) => obj.set(key, _nullToUndefined(value)))
+    } else {
+      for (const key in obj) {
+        obj[key] = _nullToUndefined(obj[key]) as any
+      }
+    }
+  }
+
+  return obj as any
+}
+
+/**
+ * Recursively converts all null values to undefined.
+ *
+ * @param obj object to convert
+ * @returns a copy of the object with all its null values converted to undefined
+ */
+export function nullToUndefined<
+  T,
+  // Can cause: "Type instantiation is excessively deep and possibly infinite."
+  // extends Jsonifiable
+>(obj: T) {
+  return _nullToUndefined(structuredClone(obj))
+}
+
+function _undefinedToNull<T>(obj: T): UndefinedToNull<T> {
+  if (obj === undefined) {
+    return null as any
+  }
+
+  if (typeof obj === 'object') {
+    if (obj instanceof Map) {
+      obj.forEach((value, key) => obj.set(key, _undefinedToNull(value)))
+    } else {
+      for (const key in obj) {
+        obj[key] = _undefinedToNull(obj[key]) as any
+      }
+    }
+  }
+
+  return obj as any
+}
+
+/**
+ * Recursively converts all undefined values to null.
+ *
+ * @param obj object to convert
+ * @returns a copy of the object with all its undefined values converted to null
+ */
+export function undefinedToNull<
+  T,
+  // Can cause: "Type instantiation is excessively deep and possibly infinite."
+  // extends Jsonifiable
+>(obj: T) {
+  return _undefinedToNull(structuredClone(obj))
+}