@vulog/aima-config 1.0.0

package/.eslintrc.js

@@ -0,0 +1,112 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        // Indicates the location of the TypeScript configuration file
+        project: 'tsconfig.json',
+        // Sets the root directory for the TypeScript configuration
+        tsconfigRootDir: __dirname,
+        // Specifies the version of ECMAScript syntax to be used
+        ecmaVersion: 'latest',
+        // Indicates the type of source code (script or module)
+        sourceType: 'module',
+    },
+    plugins: ['@typescript-eslint', 'prettier', 'import'],
+    extends: [
+        'airbnb-base',
+        'airbnb-typescript/base',
+        'plugin:@typescript-eslint/recommended',
+        'prettier',
+        'plugin:prettier/recommended',
+    ],
+    root: true,
+    env: {
+        es6: true,
+        node: true,
+    },
+    ignorePatterns: [
+        '/dist/**/*', // Ignore built files.
+        '.eslintrc.js',
+        '**/*.test.ts',
+    ],
+    rules: {
+        // Configures the Prettier integration with ESLint
+        'prettier/prettier': ['error', { endOfLine: 'auto' }],
+        // Disables the rule requiring an 'I' prefix for interfaces
+        '@typescript-eslint/interface-name-prefix': 'off',
+        // Configures the naming conventions for various code constructs
+        '@typescript-eslint/naming-convention': [
+            // ... various naming convention configurations ...
+            'error',
+            // Allows any naming format for destructured variables
+            {
+                selector: 'variable',
+                modifiers: ['destructured'],
+                format: null,
+            },
+            // Requires strict camelCase for function names
+            {
+                selector: 'function',
+                format: ['strictCamelCase'],
+            },
+            // Requires boolean variables to have one of the specified prefixes
+            {
+                selector: 'variable',
+                format: null,
+                types: ['boolean'],
+                prefix: ['is', 'should', 'has', 'can', 'did', 'will'],
+            },
+            // Requires enum names to have a strict PascalCase format
+            {
+                selector: 'enum',
+                format: ['StrictPascalCase'],
+            },
+        ],
+        'import/extensions': 'off',
+        // Disables the rule requiring explicit return types for functions
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        // Disables the rule requiring explicit boundary types for modules
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        // Disables the rule prohibiting the use of 'any' type
+        '@typescript-eslint/no-explicit-any': 'off',
+        // Disables the rule detecting unused variables
+        'no-unused-vars': 0,
+        // Disables the rule disallowing named exports used as a default export
+        'import/no-named-as-default': 0,
+        // Configures the order and formatting of import statements
+        'import/order': [
+            // ... import order configuration ...
+            'error',
+            {
+                // Configure the alphabetization settings
+                alphabetize: {
+                    // Enforce ascending alphabetical order
+                    order: 'asc',
+                    // Do not ignore the case while sorting
+                    caseInsensitive: false,
+                },
+                // Enforce newlines between different groups and inside groups of imports
+                'newlines-between': 'always-and-inside-groups',
+                // Warn when there is an import statement that is not part of any group
+                warnOnUnassignedImports: true,
+            },
+        ],
+        // Configures the rule detecting extraneous dependencies
+        'import/no-extraneous-dependencies': [
+            // ... extraneous dependencies configuration ...
+            'error',
+            {
+                // Specify the file patterns where devDependencies imports are allowed
+                devDependencies: [
+                    // Allow devDependencies imports in test and spec files
+                    '**/*.test.{ts,js}',
+                    '**/*.spec.{ts,js}',
+                    // Allow devDependencies imports in the 'test' folder
+                    './test/**.{ts,js}',
+                    // Allow devDependencies imports in the 'scripts' folder
+                    './scripts/**/*.{ts,js}',
+                ],
+            },
+        ],
+        'import/prefer-default-export': 'off',
+    },
+};

package/README.md

@@ -0,0 +1,19 @@
+# @vulog/aima-config
+
+```bash
+npm i @vulog/aima-client @vulog/aima-core @vulog/aima-config
+```
+
+```javascript
+import { getClient } from '@vulog/aima-client';
+import { getBookingRequests } from '@vulog/aima-config';
+
+const client = getClient({
+    apiKey: '...',
+    baseUrl: '...',
+    clientId: '...',
+    clientSecret: '...',
+    fleetId: '...',
+});
+
+```

package/dist/index.d.mts

@@ -0,0 +1,41 @@
+import { Client } from '@vulog/aima-client';
+
+type City = {
+    id: string;
+    name: string;
+    locale: string;
+    imagesUrl: string;
+    tokenIconsUrl?: string;
+    lat: number;
+    lon: number;
+    zoomLevel: number;
+    radius: number;
+    termsOfUseUrl: string;
+    termsOfUseUpdateDatetime: string;
+    faqUrl: string;
+    contactPhoneNumber: string;
+    agreementsDate: string;
+    timeZone: string;
+    distanceUnit: string;
+    contactUrl: string;
+    services: string[];
+    zoneId: string;
+    [key: string]: any;
+};
+declare const getCities: (client: Client) => Promise<City[]>;
+
+type Service = {
+    id: string;
+    name: string;
+    status: 'ACTIVE' | 'DISABLED';
+    type: 'FREE_FLOATING' | 'FREE_FLOATING_STRICT' | 'SERVICE_TRIP' | 'BOOKING' | 'ROUND_TRIP_BOOKING' | 'BY_PASS_FREE_FLOATING' | 'BY_PASS_ROUND_TRIP_BOOKING' | 'SUBSCRIPTION' | 'SCHEDULED_BOOKING_STATION';
+    cityId: string;
+    zones: string[];
+    vehicles: string[];
+    stations: string[];
+    pois: string[];
+    [key: string]: any;
+};
+declare const getServices: (client: Client) => Promise<Service[]>;
+
+export { type City, type Service, getCities, getServices };

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import { Client } from '@vulog/aima-client';
+
+type City = {
+    id: string;
+    name: string;
+    locale: string;
+    imagesUrl: string;
+    tokenIconsUrl?: string;
+    lat: number;
+    lon: number;
+    zoomLevel: number;
+    radius: number;
+    termsOfUseUrl: string;
+    termsOfUseUpdateDatetime: string;
+    faqUrl: string;
+    contactPhoneNumber: string;
+    agreementsDate: string;
+    timeZone: string;
+    distanceUnit: string;
+    contactUrl: string;
+    services: string[];
+    zoneId: string;
+    [key: string]: any;
+};
+declare const getCities: (client: Client) => Promise<City[]>;
+
+type Service = {
+    id: string;
+    name: string;
+    status: 'ACTIVE' | 'DISABLED';
+    type: 'FREE_FLOATING' | 'FREE_FLOATING_STRICT' | 'SERVICE_TRIP' | 'BOOKING' | 'ROUND_TRIP_BOOKING' | 'BY_PASS_FREE_FLOATING' | 'BY_PASS_ROUND_TRIP_BOOKING' | 'SUBSCRIPTION' | 'SCHEDULED_BOOKING_STATION';
+    cityId: string;
+    zones: string[];
+    vehicles: string[];
+    stations: string[];
+    pois: string[];
+    [key: string]: any;
+};
+declare const getServices: (client: Client) => Promise<Service[]>;
+
+export { type City, type Service, getCities, getServices };

package/dist/index.js

@@ -0,0 +1,45 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  getCities: () => getCities,
+  getServices: () => getServices
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/getCities.ts
+var getCities = async (client) => {
+  return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/cities`).then(
+    ({ data }) => data.filter((city) => city.fleetId === client.clientOptions.fleetId).map(({ fleetId, ...city }) => city)
+  );
+};
+
+// src/getServices.ts
+var getServices = async (client) => {
+  return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/services`).then(
+    ({ data }) => data.filter((city) => city.fleetId === client.clientOptions.fleetId).map(({ fleetId, ...service }) => service)
+  );
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getCities,
+  getServices
+});

package/dist/index.mjs

@@ -0,0 +1,17 @@
+// src/getCities.ts
+var getCities = async (client) => {
+  return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/cities`).then(
+    ({ data }) => data.filter((city) => city.fleetId === client.clientOptions.fleetId).map(({ fleetId, ...city }) => city)
+  );
+};
+
+// src/getServices.ts
+var getServices = async (client) => {
+  return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/services`).then(
+    ({ data }) => data.filter((city) => city.fleetId === client.clientOptions.fleetId).map(({ fleetId, ...service }) => service)
+  );
+};
+export {
+  getCities,
+  getServices
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "@vulog/aima-config",
+    "version": "1.0.0",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsup",
+        "dev": "tsup --watch",
+        "test": "vitest run",
+        "test:watch": "vitest"
+    },
+    "keywords": [
+        "AIMA",
+        "VULOG",
+        "CONFIG"
+    ],
+    "author": "Vulog",
+    "license": "ISC",
+    "devDependencies": {
+        "@types/lodash": "^4.17.12",
+        "@types/node": "^22.7.9",
+        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-config-airbnb-typescript": "^18.0.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-import": "^2.31.0",
+        "eslint-plugin-prettier": "^5.2.1",
+        "eslint-plugin-unused-imports": "^4.1.4",
+        "prettier": "^3.3.3",
+        "tsup": "^8.3.0",
+        "typescript": "^5.6.3",
+        "vitest": "^2.1.3"
+    },
+    "peerDependencies": {
+        "@vulog/aima-client": "^1.0.0",
+        "@vulog/aima-core": "^1.0.0",
+        "lodash": "^4.17.21",
+        "zod": "^3.23.8"
+    },
+    "description": ""
+}

package/src/getCities.ts

@@ -0,0 +1,38 @@
+import { Client } from '@vulog/aima-client';
+
+export type City = {
+    id: string;
+    name: string;
+    locale: string;
+    imagesUrl: string;
+    tokenIconsUrl?: string;
+    lat: number;
+    lon: number;
+    zoomLevel: number;
+    radius: number;
+    termsOfUseUrl: string;
+    termsOfUseUpdateDatetime: string;
+    faqUrl: string;
+    contactPhoneNumber: string;
+    agreementsDate: string;
+    timeZone: string;
+    distanceUnit: string;
+    contactUrl: string;
+    services: string[];
+    zoneId: string;
+    [key: string]: any;
+};
+
+export const getCities = async (client: Client): Promise<City[]> => {
+    return client
+        .get<
+            (City & {
+                fleetId: string;
+            })[]
+        >(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/cities`)
+        .then(({ data }) =>
+            data
+                .filter((city) => city.fleetId === client.clientOptions.fleetId)
+                .map(({ fleetId, ...city }) => city as City)
+        );
+};

package/src/getServices.ts

@@ -0,0 +1,37 @@
+import { Client } from '@vulog/aima-client';
+
+export type Service = {
+    id: string;
+    name: string;
+    status: 'ACTIVE' | 'DISABLED';
+    type:
+        | 'FREE_FLOATING'
+        | 'FREE_FLOATING_STRICT'
+        | 'SERVICE_TRIP'
+        | 'BOOKING'
+        | 'ROUND_TRIP_BOOKING'
+        | 'BY_PASS_FREE_FLOATING'
+        | 'BY_PASS_ROUND_TRIP_BOOKING'
+        | 'SUBSCRIPTION'
+        | 'SCHEDULED_BOOKING_STATION';
+    cityId: string;
+    zones: string[];
+    vehicles: string[];
+    stations: string[];
+    pois: string[];
+    [key: string]: any;
+};
+
+export const getServices = async (client: Client): Promise<Service[]> => {
+    return client
+        .get<
+            (Service & {
+                fleetId: string;
+            })[]
+        >(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/services`)
+        .then(({ data }) =>
+            data
+                .filter((city) => city.fleetId === client.clientOptions.fleetId)
+                .map(({ fleetId, ...service }) => service as Service)
+        );
+};

package/src/index.ts

@@ -0,0 +1,4 @@
+export { getCities } from './getCities';
+export type { City } from './getCities';
+export { getServices } from './getServices';
+export type { Service } from './getServices';

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "include": ["src"],
+    "exclude": ["**/*.test.ts"],
+    "compilerOptions": {
+        "module": "esnext",
+        "target": "esnext",
+        "lib": ["esnext"],
+        "declaration": true,
+        "strict": true,
+        "moduleResolution": "node",
+        "skipLibCheck": true,
+        "esModuleInterop": true,
+        "outDir": "dist",
+        "rootDir": "src"
+    }
+}

package/tsup.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+    entry: ['src/index.ts'],
+    clean: true,
+    format: ['cjs', 'esm'],
+    dts: true,
+});

package/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: 'node',
+    },
+});