update docs for npm i command, expose dataConnector

Author: ivictbor

Changelog.md

@@ -20,6 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 # Improved
 
 - Added separate BeforeCreateSave function in types without oldRecord and make oldRecord Mandatory in existing BeforeSaveFunction
+  
+- Added dataConnector: IAdminForthDataSourceConnectorBase; into IOperationalResource - for reusing connectors from users code
 
 ## [v1.5.7] - 2024-12-09
 

adminforth/documentation/blog/2024-10-01-ai-blog/index.md

@@ -41,8 +41,8 @@ nvm use 20
 mkdir ai-blog
 cd ai-blog
 npm init -y
-npm install adminforth @adminforth/upload @adminforth/rich-editor @adminforth/chat-gpt \
- express slugify http-proxy @types/express typescript tsx @types/node --save-dev
+npm i adminforth @adminforth/upload @adminforth/rich-editor @adminforth/chat-gpt \
+ express slugify http-proxy @types/express typescript tsx @types/node -D
 npx --yes tsc --init --module NodeNext --target ESNext
 ```
 

adminforth/documentation/docs/tutorial/001-gettingStarted.md

@@ -26,13 +26,13 @@ npm install adminforth
 AdminForth does not provide own HTTP server, but can add own listeners over exisitng [Express](https://expressjs.com/) server (Fastify support is planned in future). This allows to create custom APIs for backoffice in a way you know.
 
 ```bash
-npm install express
+npm i express
 ```
 
 You can use AdminForth in pure Node, but we recommend using TypeScript for better development experience:
 
 ```bash
-npm install typescript@5.4.5 tsx@4.11.2 @types/express @types/node --save-dev
+npm i typescript@5.4.5 tsx@4.11.2 @types/express @types/node -D
 echo '{
   "compilerOptions": {
     "target": "esnext",

adminforth/documentation/docs/tutorial/01-helloWorld.md

@@ -25,7 +25,7 @@ nvm use 20
 mkdir af-hello
 cd af-hello
 npm init -y
-npm install adminforth express @types/express typescript tsx @types/node --save-dev
+npm i adminforth express @types/express typescript tsx @types/node -D
 npx --yes tsc --init --module NodeNext --target ESNext
 ```
 

adminforth/documentation/docs/tutorial/03-Customization/02-customFieldRendering.md

@@ -175,7 +175,7 @@ npm init -y
 And simply do `npm install` for the package you need:
 
 ```bash
-npm install <some package> --save-dev
+npm i <some package> -D
 ```
 
 

adminforth/documentation/docs/tutorial/03-Customization/06-customPages.md

@@ -9,7 +9,7 @@ To add custom package to SPA bundle you have to initialize npm in `custom` direc
 ```bash
 cd ./custom
 npm init -y
-npm install apexcharts --save-dev
+npm i apexcharts -D
 ```
 
 > 👆 Note: for better development experience we recommend to create file `custom/tsconfig.json` with the following content:

adminforth/documentation/docs/tutorial/03-Customization/08-pageInjections.md

@@ -138,7 +138,7 @@ onMounted(async () => {
 Then initialize npm in `custom` directory if you didn't do this and install required packages:
 ```bash
 npm init -y
-npm install apexcharts --save-dev
+npm i apexcharts -D
 ```
 
 Also we have to add an Api to get percentages:

adminforth/documentation/docs/tutorial/06-Advanced/01-plugin-development.md

@@ -23,7 +23,7 @@ mkdir -p af-plugin-chatgpt
 cd af-plugin-chatgpt
 npm init -y
 touch index.ts
-npm i --save-dev typescript @types/node
+npm i typescript @types/node -D
 ```
 
 Edit `package.json`:
@@ -221,7 +221,7 @@ npm init -y
 Now install our dependency:
 
 ```bash
-npm i --save-dev vue-suggestion-input 
+npm i vue-suggestion-input -D
 ```
 
 Create file `completionInput.vue`:

adminforth/modules/utils.ts

@@ -370,9 +370,6 @@ export function md5hash(str:string) {
 export class RateLimiter {
   static counterData = {};
 
-
-
-
   /**
    * Very dirty version of ratelimiter for demo purposes (should not be considered as production ready)
    * Will be used as RateLimiter.checkRateLimit('key', '5/24h', clientIp)
@@ -432,7 +429,6 @@ export class RateLimiter {
       RateLimiter.decrementCounter(key, clientIp);
     }, whenClear.getTime() - Date.now());
 
-
     return { error: false };
 
   }
@@ -445,7 +441,6 @@ export class RateLimiter {
       RateLimiter.counterData[key][ip] = 0;
     }
     RateLimiter.counterData[key][ip]++;
-    console.log('🔄️🔄️🔄️🔄️🔄️🔄️ incremented', key, ip, this.counterData[key][ip]);
   }
 
   static decrementCounter(key: string, ip: string) {
@@ -458,9 +453,6 @@ export class RateLimiter {
     if (RateLimiter.counterData[key][ip] > 0) {
       RateLimiter.counterData[key][ip]--;
     }
-    console.log('🔄️🔄️🔄️🔄️🔄️🔄️ decremented', key, ip, this.counterData[key][ip]);
-
   }
 
-
 }