@bratislava/ginis-sdk 0.3.2 → 0.3.5

package/src/api/xml/ude.ts

@@ -1,141 +0,0 @@
-// full UDE service docs: https://robot.gordic.cz/xrg/Default.html?c=OpenModuleDetail&moduleName=SSL&language=cs-CZ&version=390
-import type { AxiosRequestConfig } from 'axios'
-import type { GinisConfig } from '../../ginis'
-import { makeAxiosRequest } from '../../utils/api'
-
-/**
- * Full docs: https://robot.gordic.cz/xrg/Default.html?c=OpenMethodDetail&moduleName=UDE&version=390&methodName=seznam-dokumentu&type=request
- */
-export type seznamDokumentu = {
-  /**
-   * UDE - Vrátit pouze informace evidované v GINIS modulu Úřední deska. Tj. základní informace o vyvěšeném záznamu. Elementy: Id-zaznamu ... Id-dokumentu.
-   * UDEWFL - Když byl záznam vyvěšen z GINIS modulu, jsou o něm dotaženy základní informace (další možno získat voláním XRG-SSL). Elementy: Id-zaznamu ... Id-dokumentu + Puvod-dokumentu ... Cj-spisu
-   * UDESML - Když byl záznam vyvěšen z GINIS modulu SML, jsou o něm dotaženy informace. Elementy: Id-zaznamu ... Id-dokumentu + Cislo-sml ... Odbor-sml.
-   * UDEWFLSML - Informace UDE + WFL + SML. Vrátí vše.
-   */
-  'Vratit-info'?: 'UDE' | 'UDEWFL' | 'UDESML' | 'UDEWFLSML'
-  /**
-   * vyveseno - vyvěšeno
-   * sejmuto - sejmuto
-   */
-  Stav?: string
-  'Id-uredni-desky'?: string
-  'Id-kategorie'?: string
-  /**
-   * ISO-string date format
-   */
-  'Vyveseno-od'?: string
-  /**
-   * ISO-string date format
-   */
-  'Vyveseno-od-horni-mez'?: string
-  /**
-   * ISO-string date format
-   */
-  'Sejmuto-od'?: string
-  /**
-   * ISO-string date format
-   */
-  'Sejmuto-od-horni-mez'?: string
-  /**
-   * Název záznamu. Hledáno přes LIKE "%hodnota%" bez ohledu na diakritiku a velikost písmen (na db stroji Informix s ohledem na diakritiku)
-   * Max 254 chars
-   */
-  Nazev?: string
-  /**
-   * Popis záznamu.  Hledáno přes LIKE "%hodnota%" bez ohledu na diakritiku a velikost písmen (na db stroji Informix s ohledem na diakritiku)
-   * Max 254 chars
-   */
-  Popis?: string
-  Zdroj?: string
-  /**
-   * rucni-evidence - ruční evidence
-   * elektronicke-podani - elektronické podání
-   * datova-schranka - datová schránka
-   * interface-xrg - interface, xrg
-   */
-  'Puvod-dokumentu'?: string
-  'Odesilatel-dokumentu'?: string
-  'Cj-spisu'?: string
-  /**
-   * ISO-string date-time format
-   */
-  'Datum-zmeny'?: string
-  /**
-   * ISO-string date-time format
-   */
-  'Datum-zmeny-horni-mez'?: string
-  'Cislo-sml'?: string
-  'Typ-sml'?: string
-  'Nazev-sml'?: string
-  'Nazev-sub-sml'?: string
-  'Prijmeni-sub-sml'?: string
-  'Jmeno-sub-sml'?: string
-  'Ico-sub-sml'?: string
-  'Obec-sub-sml'?: string
-  'Ulice-sub-sml'?: string
-  'Cor-sub-sml'?: string
-  'Cpop-sub-sml'?: string
-  'Psc-sub-sml'?: string
-  'Typ-sub-sml'?: string
-  /**
-   * ISO-string date format
-   */
-  'Datum-uzavreni-sml-od'?: string
-  /**
-   * ISO-string date format
-   */
-  'Datum-uzavreni-sml-do'?: string
-  'Odbor-sml'?: string
-  'Celkova-castka-od-sml'?: string
-  'Celkova-castka-do-sml'?: string
-  'Mena-sml'?: string
-}
-
-export const seznamDokumentu = async (
-  config: GinisConfig,
-  url: string | undefined,
-  bodyObj: seznamDokumentu
-) => {
-  const axiosConfig: AxiosRequestConfig = {
-    headers: {
-      'Content-Type': 'text/xml; charset=utf-8',
-      SOAPAction: 'http://www.gordic.cz/svc/xrg-ude/v_1.0.0.0/Seznam-dokumentu',
-    },
-  }
-  const body = `
-        <s:Envelope
-          xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
-          xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
-          <s:Header>
-            <o:Security s:mustUnderstand="1"
-              xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
-              <o:UsernameToken u:Id="uuid-ea5d8d3d-df90-4b69-b034-9026f34a3f21-1">
-                <o:Username>${config.username}</o:Username>
-                <o:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">${
-                  config.password
-                }</o:Password>
-              </o:UsernameToken>
-            </o:Security>
-          </s:Header>
-          <s:Body>
-            <Seznam-dokumentu
-              xmlns="http://www.gordic.cz/svc/xrg-ude/v_1.0.0.0">
-              <requestXml>
-                <Xrg
-                  xmlns="http://www.gordic.cz/xrg/ude/seznam-dokumentu/request/v_1.0.0.0">
-                  <Seznam-dokumentu>
-                    ${Object.entries(bodyObj).map(([key, value]) => `<${key}>${value}</${key}>`)}
-                  </Seznam-dokumentu>
-                </Xrg>
-              </requestXml>
-            </Seznam-dokumentu>
-          </s:Body>
-        </s:Envelope>
-      `
-  return makeAxiosRequest(axiosConfig, url, body, config.debug)
-}
-
-export default {
-  seznamDokumentu,
-}

package/src/ginis.ts

@@ -1,58 +0,0 @@
-import ssl from './api/json/ssl'
-import pod from './api/json/pod'
-import { bind, mapValues } from 'lodash'
-
-export type GinisConfig = {
-  username: string
-  password: string
-  urls: {
-    ude?: string
-    ssl?: string
-    pod?: string
-  }
-  debug?: boolean
-}
-
-// presently empty, prepared in case we're to add default values in the future
-export const defaultConfig = {}
-
-type _Ssl = typeof ssl
-/**
- * full SSL service docs: https://robot.gordic.cz/xrg/Default.html?c=OpenModuleDetail&moduleName=SSL&language=cs-CZ&version=390
- */
-export type Ssl = {
-  [P in keyof _Ssl]: OmitThisParameter<_Ssl[P]>
-}
-
-type _Pod = typeof pod
-/**
- * full POD service docs: https://robot.gordic.cz/xrg/Default.html?c=OpenModuleDetail&moduleName=POD&language=cs-CZ&version=390
- */
-export type Pod = {
-  [P in keyof _Pod]: OmitThisParameter<_Pod[P]>
-}
-
-// exports all services with server config bound to the one passed at construction
-export class Ginis {
-  config: GinisConfig
-  /**
-   * Exports functions of the api's with config and url values bound.
-   * See documentation of the api for request options.
-   * Inputs are typed objects, outputs unformatted xml.
-   */
-  json: {
-    ssl: Ssl
-    pod: Pod
-  }
-
-  constructor(config: GinisConfig) {
-    this.config = {
-      ...defaultConfig,
-      ...config,
-    }
-    this.json = {
-      ssl: mapValues(ssl, (v) => bind(v, this)),
-      pod: mapValues(pod, (v) => bind(v, this)),
-    }
-  }
-}

package/src/index.ts

@@ -1,6 +0,0 @@
-// exporting axios error for easier handling of possible throws
-import { AxiosError } from 'axios'
-import { Ginis, GinisConfig } from './ginis'
-import { GinisError } from './utils/errors'
-
-export { Ginis, GinisConfig, AxiosError, GinisError }

package/src/utils/api.ts

@@ -1,78 +0,0 @@
-import axios, { AxiosRequestConfig } from 'axios'
-import crypto from 'crypto'
-import type { GinisConfig } from '../ginis'
-
-const defaultAxiosConfig: AxiosRequestConfig = {
-  headers: {
-    'Content-Type': 'application/json',
-  },
-}
-
-export const makeAxiosRequest = async <T>(
-  axiosConfig: AxiosRequestConfig | undefined,
-  url: string | undefined,
-  body: string | object,
-  debug?: boolean
-) => {
-  if (!url) {
-    throw new Error('Missing GINIS url for the service you are trying to reach.')
-  }
-
-  const requestConfig = axiosConfig || defaultAxiosConfig
-
-  if (debug) {
-    console.log('########### GINIS REQUEST ###########')
-    console.log('headers: ', requestConfig.headers)
-    console.log('body: ', body)
-    console.log('########### GINIS REQUEST END ###########')
-  }
-  let responseAxios
-  try {
-    responseAxios = await axios.post<T>(url, body, requestConfig)
-  } catch (error) {
-    if (debug) {
-      let anyError = error as any
-      console.error(anyError)
-      console.log('########### GINIS ERROR RESPONSE ###########')
-      console.log('status: ', anyError?.response?.status)
-      console.log('statusText: ', anyError?.response?.statusText)
-      console.log('data: ', anyError?.response?.data)
-      console.log('########### GINIS RESPONSE END ###########')
-    }
-    throw error
-  }
-  if (debug) {
-    console.log('########### GINIS RESPONSE ###########')
-    console.log('status: ', responseAxios.status)
-    console.log('statusText: ', responseAxios.statusText)
-    console.log('data: ', responseAxios.data)
-    console.log('########### GINIS RESPONSE END ###########')
-  }
-  return {
-    data: responseAxios.data,
-    status: responseAxios.status,
-    statusText: responseAxios.statusText,
-  }
-}
-
-export type GRestHeader = {
-  RequestName: string
-  RequestNamespace: string
-  User: string
-  Password: string
-  PasswordText: boolean
-  Nonce: string
-  Created: string
-}
-
-export const getGRestHeader = (config: GinisConfig, requestNamespace: string): GRestHeader => {
-  return {
-    RequestName: 'Xrg',
-    RequestNamespace: requestNamespace,
-    User: config.username,
-    Password: config.password,
-    PasswordText: true,
-    Nonce: crypto.randomBytes(10).toString('base64'),
-    Created: new Date().toISOString(),
-  }
-}

package/src/utils/errors.ts

@@ -1,7 +0,0 @@
-// may get more data later
-// for now serves as a way to easily distinguish in client code by instance type
-export class GinisError extends Error {
-  constructor(message: string) {
-    super(message)
-  }
-}

package/src/utils/types.ts

@@ -1,7 +0,0 @@
-export type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R
-  ? (...args: P) => R
-  : never
-
-export type OmitFirstTwoArgs<F> = F extends (x: any, y: any, ...args: infer P) => infer R
-  ? (...args: P) => R
-  : never

package/tsconfig.json

@@ -1,37 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "Node 16 + ESM + Strictest",
-  "compilerOptions": {
-    "outDir": "dist",
-    "lib": ["es2021"],
-    "module": "es2022",
-    "target": "es2021",
-    "allowJs": true,
-    "strict": true,
-    "strictBindCallApply": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "moduleResolution": "node",
-    "allowUnusedLabels": false,
-    "allowUnreachableCode": false,
-    "exactOptionalPropertyTypes": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noUncheckedIndexedAccess": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "checkJs": true,
-    "declaration": true,
-    "declarationMap": true,
-    "plugins": [
-      {
-        "name": "typescript-strict-plugin"
-      }
-    ]
-  },
-  "include": ["src/**/*"],
-  "exclude": ["dist", "docs", "node_modules", "bin"]
-}

package/tsconfig.spec.json

@@ -1,5 +0,0 @@
-{
-  "compilerOptions": {
-    "types": ["jest", "node"]
-  }
-}

package/typedoc.json

@@ -1,9 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts", "./src/api/ssl.ts", "./src/api/ude.ts"],
-  "entryPointStrategy": "Expand",
-  "plugin": ["typedoc-theme-hierarchy"],
-  "theme": "hierarchy",
-  "name": "GINIS SDK",
-  "out": "docs"
-}

package/webpack.config.js

@@ -1,42 +0,0 @@
-const path = require('path')
-const ESLintPlugin = require('eslint-webpack-plugin')
-
-module.exports = {
-  entry: './src/index.ts',
-  devtool: 'inline-source-map',
-  module: {
-    rules: [
-      {
-        test: /\.tsx?$/,
-        use: 'ts-loader',
-        exclude: /node_modules/,
-      },
-    ],
-  },
-  resolve: {
-    extensions: ['.tsx', '.ts', '.js'],
-    fallback: {
-      crypto: require.resolve('crypto-browserify'),
-      stream: require.resolve('stream-browserify'),
-    },
-  },
-  output: {
-    path: path.resolve(__dirname, 'dist'),
-    filename: 'ginis-sdk.js',
-    globalObject: 'this',
-    library: {
-      name: 'ginis-sdk',
-      type: 'umd',
-    },
-  },
-  mode: 'production',
-  plugins: [new ESLintPlugin()],
-  externals: {
-    lodash: {
-      commonjs: 'lodash',
-      commonjs2: 'lodash',
-      amd: 'lodash',
-      root: '_',
-    },
-  },
-}