@stack-spot/portal-network 0.1.0

package/dist/network/react-query-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-query-client.js","sourceRoot":"","sources":["../../src/network/react-query-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEnD,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,EAAE,oBAAoB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA"}

package/dist/network/types.d.ts

@@ -0,0 +1,55 @@
+import type { RequestOpts } from '@oazapfts/runtime';
+import { Session } from '@stack-spot/auth';
+import { MutateOptions, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
+import { StackspotAPIError } from '../error/StackspotAPIError.js';
+export interface SessionManager {
+    hasSession(): boolean;
+    endSession(): void;
+    getSession(): Session;
+}
+export interface RequestOptions {
+    params?: Record<string, string | undefined>;
+    headers?: Record<string, string>;
+}
+export interface RequestWithBody extends RequestOptions {
+    body?: string | object | FormData;
+}
+export type Env = 'dev' | 'stg' | 'prd';
+export type HTTPMethod = 'post' | 'patch' | 'delete' | 'put' | 'get';
+export interface OperationConfig<Args extends [AbortSignal, Record<string, any>] | [AbortSignal], Result> {
+    name: string;
+    request: (...args: Args) => Promise<Result>;
+    permission: (...args: Args extends [AbortSignal] ? [] : [Args[1]]) => Promise<boolean>;
+}
+export interface FullOperationConfig<Args extends [AbortSignal, Record<string, any>] | [AbortSignal], Result> extends OperationConfig<Args, Result> {
+    apiName: string;
+}
+export interface OperationObject<Variables> {
+    isAllowed: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => Promise<boolean>;
+    useAllowed: (...args: Variables extends void ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>] : [variables?: Partial<Variables>, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]) => Readonly<[boolean | undefined, boolean, StackspotAPIError | null | undefined, UseQueryResult<boolean, StackspotAPIError>]>;
+    getPermissionKey: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => any[];
+    cancel: (variables?: Partial<Variables>) => boolean;
+}
+export interface QueryObject<Variables, Result> extends OperationObject<Variables> {
+    query: (...args: Variables extends void ? [] : [variables: Variables]) => Promise<Result>;
+    useQuery: (...args: Variables extends void ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>] : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]) => Result | undefined;
+    useStatefulQuery: (...args: Variables extends void ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>] : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]) => Readonly<[Result | undefined, boolean, StackspotAPIError | null | undefined, UseQueryResult<Result, StackspotAPIError>]>;
+    invalidate: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => Promise<void>;
+    getKey: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => any[];
+}
+export interface AutoQueryObjectParams<Variables, Result> {
+    apiName: string;
+    fn: ((variables: Variables, opts?: RequestOpts) => Promise<Result>) | ((opts?: RequestOpts) => Promise<Result>);
+    onFetchPermission: typeof fetch;
+    transformError?: (error: any) => StackspotAPIError;
+}
+export interface MutationObject<Variables, Result> extends OperationObject<Variables> {
+    mutate: (...args: Variables extends void ? [] : [variables: Variables]) => Promise<Result>;
+    useMutation: (options?: Omit<UseMutationOptions<Result, StackspotAPIError, Variables>, 'mutationFn'>) => Readonly<[
+        (...args: Variables extends void ? [options?: MutateOptions<Result, StackspotAPIError>] : [variables: Variables, options?: MutateOptions<Result, StackspotAPIError, Variables>]) => Promise<Result>,
+        boolean,
+        StackspotAPIError | undefined,
+        UseMutationResult<Result, StackspotAPIError, Variables>
+    ]>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/network/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/network/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC7H,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAE9D,MAAM,WAAW,cAAc;IAC7B,UAAU,IAAI,OAAO,CAAC;IACtB,UAAU,IAAI,IAAI,CAAC;IACnB,UAAU,IAAI,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,eAAgB,SAAQ,cAAc;IACrD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;CACnC;AAED,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAEvC,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,KAAK,CAAA;AAEpE,MAAM,WAAW,eAAe,CAAC,IAAI,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,MAAM;IACtG,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACxF;AAED,MAAM,WAAW,mBAAmB,CAClC,IAAI,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,MAAM,CACvE,SAAQ,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe,CAAC,SAAS;IACxC,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACzG,UAAU,EAAE,CACV,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAC3B,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,GACzD,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,KAC1F,QAAQ,CAAC,CAAC,OAAO,GAAG,SAAS,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,EAAE,cAAc,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAChI,gBAAgB,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;IACrG,MAAM,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC;CACrD;AAED,MAAM,WAAW,WAAW,CAAC,SAAS,EAAE,MAAM,CAAE,SAAQ,eAAe,CAAC,SAAS,CAAC;IAChF,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1F,QAAQ,EAAE,CACR,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAC3B,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,GACzD,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,KAChF,MAAM,GAAG,SAAS,CAAC;IACxB,gBAAgB,EAAE,CAChB,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAC3B,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,GACzD,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,KAChF,QAAQ,CAAC,CAAC,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,EAAE,cAAc,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC9H,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvG,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;CAC5F;AAED,MAAM,WAAW,qBAAqB,CAAC,SAAS,EAAE,MAAM;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAChH,iBAAiB,EAAE,OAAO,KAAK,CAAC;IAChC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,iBAAiB,CAAC;CACpD;AAED,MAAM,WAAW,cAAc,CAAC,SAAS,EAAE,MAAM,CAAE,SAAQ,eAAe,CAAC,SAAS,CAAC;IACnF,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3F,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,EAAE,SAAS,CAAC,EAAE,YAAY,CAAC,KAClG,QAAQ,CAAC;QACP,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAC5B,CAAC,OAAO,CAAC,EAAG,aAAa,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,GACrD,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC,KACpF,OAAO,CAAC,MAAM,CAAC;QACpB,OAAO;QAAE,iBAAiB,GAAG,SAAS;QACtC,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,EAAE,SAAS,CAAC;KACxD,CAAC,CAAC;CACN"}

package/dist/network/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/network/types.js.map

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

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@stack-spot/portal-network",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./api/*": "./dist/api/*.js"
+  },
+  "peerDependencies": {
+    "@stack-spot/auth": "^5.2.0",
+    "@stack-spot/opa": "^2.2.0",
+    "@stack-spot/portal-translate": "^1.0.0",
+    "@tanstack/react-query": "^5.1.9",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@inquirer/checkbox": "^2.3.5",
+    "@inquirer/prompts": "^5.0.5",
+    "@types/cli-progress": "^3.11.5",
+    "@types/node": "^20.14.2",
+    "@types/react": "^18.2.37",
+    "@types/react-dom": "^18.2.15",
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
+    "@typescript-eslint/parser": "^6.10.0",
+    "cli-progress": "^3.12.0",
+    "eslint": "^8.53.0",
+    "eslint-plugin-filenames": "^1.3.2",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-lodash": "^7.4.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.4",
+    "inquirer-interactive-list-prompt": "^1.0.4",
+    "oazapfts": "^6.1.0",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "rimraf": "^5.0.7",
+    "tsc-esm-fix": "^2.20.26",
+    "tsc-silent": "^1.2.2",
+    "tsx": "^4.15.1",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@oazapfts/runtime": "^1.0.3",
+    "lodash": "^4.17.21"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc-silent -p tsconfig.build.json --suppress @/src/api/ && tsc-esm-fix --target='dist'",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "generate": "tsx ./scripts/generate-apis.ts"
+  }
+}

package/readme.md

@@ -0,0 +1 @@
+# Network

package/scripts/generate-apis.ts

@@ -0,0 +1,134 @@
+/* eslint-disable no-console */
+
+import { exec } from 'child_process'
+import { readFile, unlink, writeFile } from 'fs/promises'
+import checkbox from '@inquirer/checkbox'
+import { Presets, SingleBar } from 'cli-progress'
+// @ts-ignore
+import list from 'inquirer-interactive-list-prompt'
+import apis from '../src/apis.json'
+
+const MAX_ATTEMPTS = 5
+const DELAY_MS = 2000
+const TARGET_DIR = 'src/api'
+const LOG_FILE = '.generate-api.failed.json'
+const envs = [
+  { name: 'Production', value: 'prd', key: 'p' },
+  { name: 'Staging', value: 'stg', key: 's' },
+  { name: 'Development', value: 'dev', key: 'd' },
+] as const
+
+function delay() {
+  return new Promise<void>(resolve => {
+    setTimeout(resolve, DELAY_MS)
+  })
+}
+
+function generateAPICode(name: string, docsUrl: any) {
+  return new Promise<string>((resolve, reject) => {
+    let output = ''
+    const child = exec(
+      `pnpm oazapfts ${docsUrl} ${TARGET_DIR}/${name}.ts --optimistic --argumentStyle object`,
+      (_, out, err) => output += out || err,
+    )
+    child.on('error', err => reject(err.message))
+    child.on('close', code => code === 0 ? resolve(output) : reject(output))
+  })
+}
+
+async function generateCodeForAPIs(apiNames: (keyof typeof apis)[], env: 'dev' | 'stg' | 'prd') {
+  let progress = 0
+  const progressBar = new SingleBar({ clearOnComplete: true, stopOnComplete: true }, Presets.shades_classic)
+  progressBar.start(apiNames.length, 0)
+  const succeeded: string[] = []
+  const failed: string[] = []
+  const errors: string[] = []
+  await Promise.all(apiNames.map(async (name) => {
+    let retries = MAX_ATTEMPTS
+    while (retries > 0) {
+      try {
+        const api = apis[name]
+        if ('docs' in api) {
+          const docsUrl = `${api.url[env]}${api.docs}`
+          await generateAPICode(name, docsUrl)
+        }
+        retries = 0
+        succeeded.push(name)
+        progressBar.update(++progress)
+      } catch (error: any) {
+        retries--
+        await delay()
+        if (retries === 0) {
+          errors.push(error.message || `${error}`)
+          failed.push(name)
+          progressBar.update(++progress)
+        }
+      }
+    }
+  }))
+  const succeededStr = succeeded.length ? ` Code generated successfully for ${succeeded.length} APIs.` : ''
+  const failedStr = failed.length ? ` Failed to generate code for ${failed.length} APIs. Check the logs below.` : ''
+  console.log(`\nFinished!${succeededStr}${failedStr}`)
+  if (succeeded.length) {
+    console.log('\n> Generated code for:')
+    succeeded.forEach(api => console.log(`  - ${api}`))
+    await removeLastFailed()
+  }
+  if (failed.length) {
+    console.log('\n> Failed to generate code for:')
+    failed.forEach(api => console.log(`  - ${api}`))
+    await saveFailed(failed)
+  }
+  if (errors.length) throw new Error(errors.join('\n\n'))
+}
+
+async function getLastFailed(): Promise<(keyof typeof apis)[]> {
+  try {
+    const raw = await readFile(LOG_FILE, { encoding: 'utf-8' })
+    return JSON.parse(raw)
+  } catch {
+    return []
+  }
+}
+
+async function removeLastFailed() {
+  try {
+    await unlink(LOG_FILE)
+  // eslint-disable-next-line no-empty
+  } catch {}
+}
+
+async function saveFailed(failed: string[]) {
+  try {
+    await writeFile(LOG_FILE, JSON.stringify(failed), { encoding: 'utf-8' })
+  // eslint-disable-next-line no-empty
+  } catch {}
+}
+
+async function start() {
+  try {
+    const cmdEnvArg = process.argv[2]
+    const allAPINames = Object.keys(apis) as (keyof typeof apis)[]
+    if ((envs.map(e => e.value) as string[]).includes(cmdEnvArg?.trim() ?? '')) {
+      await generateCodeForAPIs(allAPINames, cmdEnvArg as 'prd' | 'stg' | 'dev')
+    } else {
+      const lastFailed = await getLastFailed()
+      const selectedAPIs = await checkbox({
+        message: 'Select the APIs you wish to update',
+        choices: allAPINames.map(api => ({ name: api, value: api, checked: !lastFailed.length || lastFailed.includes(api) })),
+      })
+      const env: 'prd' | 'stg' | 'dev' = await list({
+        message: 'Select an environment',
+        choices: envs,
+        default: envs[0].value,
+      })
+      await generateCodeForAPIs(selectedAPIs, env)
+    }
+    process.exit(0)
+  } catch (error: any) {
+    console.error(error.message || `${error}`)
+    process.exit(1)
+  }
+}
+
+start()