Fix typos, licenses details and more

Dahkenangnon · Dec 29, 2023 · 73b44f5 · 73b44f5
1 parent 39d2d3e
commit 73b44f5
Show file tree

Hide file tree

Showing 13 changed files with 95 additions and 7 deletions.
diff --git a/package.json b/package.json
@@ -3,6 +3,30 @@
   "main": "./public/dist/bundle.js",
   "description": "Benin Republic territory data for web and JS apps",
   "version": "1.0.3",
+  "keywords": [
+    "Benin",
+    "Benin Republic",
+    "Territory",
+    "Location",
+    "Data",
+    "Cotonou",
+    "Porto-Novo",
+    "Parakou",
+    "Djougou",
+    "Bohicon",
+    "Kandi",
+    "Abomey"
+  ],
+  "maintainers": [
+    {
+      "name": "Justin Y. Dah-kenangnon",
+      "email": "[email protected]",
+      "web": "https://dah-kenangnon.com",
+      "twitter": "https://twitter.com/dahkenangnon",
+      "github": "https://github.com/Dahkenangnon"
+    }
+  ],
+  "homepage": "https://dahkenangnon.github.io/location_data_bj_js/",
   "author": {
     "name": "Justin Y. Dah-kenangnon",
     "email": "[email protected]"

diff --git a/public/index.html b/public/index.html
@@ -1,10 +1,9 @@
 <!DOCTYPE html>
 <html lang="en">
-
     <head>
         <meta charset="UTF-8">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
-        <title>BjLocationData sample </title>
+        <title>BjLocationData Demo </title>
         <style>
             /* General styles for the widget container */
             #locationDataBJ-widget {
@@ -75,7 +74,7 @@
                 text-align: center;
             }
 
-            /* Highlight the JSON outputed in the state element  */
+            /* Highlight the JSON outputted in the state element  */
             #state {
                 font-family: 'Courier New', monospace;
                 white-space:  'break-space';
@@ -155,8 +154,6 @@ <h1 class="text-center">BjLocationData, javascript library</h1>
                         stateDiv.innerHTML = JSON.stringify(locationData);
                     },
                 });
-
         </script>
     </body>
-
 </html>
diff --git a/readme.md b/readme.md
@@ -11,7 +11,7 @@ For raw data version, please visit [bj_location_data_raw](https://github.com/Dah
 >
 > Department: 12
 >
-> Twon: 77
+> Town: 77
 >
 > District: 546
 >

diff --git a/src/data/departments.ts b/src/data/departments.ts
@@ -1,3 +1,11 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
+
 import { IDepartment } from "../types/interfaces";
 
 const departments : IDepartment[] = [

diff --git a/src/data/districts.ts b/src/data/districts.ts
@@ -1,3 +1,10 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
 import { IDistrict } from "../types/interfaces"
 
 const districts : IDistrict[] = [

diff --git a/src/data/neighborhoods.ts b/src/data/neighborhoods.ts
@@ -1,3 +1,10 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
 import { INeighborhood } from "../types/interfaces"
 
 const neighborhoods: INeighborhood[] = [

diff --git a/src/data/towns.ts b/src/data/towns.ts
@@ -1,3 +1,10 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
 import { ITown } from "../types/interfaces"
 
 const towns: ITown[] = [

diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,10 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
 import departments from './data/departments';
 import towns from './data/towns';
 import districts from './data/districts';

diff --git a/src/types/interfaces.ts b/src/types/interfaces.ts
@@ -1,3 +1,10 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
 import { BjLocationData } from "./type";
 
 /** Department is the first administrative territory division in the country */
@@ -28,6 +35,9 @@ export interface INeighborhood {
 }
 
 
+/**
+ * The options to provide to the widget
+ */
 export interface BjLocationWidgetOptions {
 
     [key: string]: any;

diff --git a/src/types/type.ts b/src/types/type.ts
@@ -1,3 +1,10 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
 import { IDepartment, IDistrict,  INeighborhood, ITown } from "./interfaces";
 export type BjLocationData = (IDepartment | ITown | IDistrict | INeighborhood) & { type?: string };
 export type BjLocationType = "department" | "town" | "district" | "neighborhood";
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,3 +1,10 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
 import { townsOfDepartment, districtsOfTown, neighborhoodsOfDistrict, departmentList, townsList, districtList, neighborhoodList } from ".";
 import { IDepartment, ITown, IDistrict, INeighborhood } from "./types/interfaces";
 import { BjLocationType, BjLocationData } from "./types/type";

diff --git a/test/index.test.ts b/test/index.test.ts
@@ -1,3 +1,10 @@
+/**
+ * @license
+ * Copyright Justin Dah-kenangnon - All Rights Reserved.
+ * 
+ * @link https://dah-kenangnon.com
+ * For more details, see LICENSE.md file in root folder
+ */
 import {
     departmentList,
     townsList,

diff --git a/tsconfig.json b/tsconfig.json
@@ -3,7 +3,7 @@
     "target": "ES6",
     "module": "ESNext",
     "outDir": "public/dist",
-    "typeRoots": ["node_modules/@types", "src/@types"],
+    "typeRoots": ["node_modules/@types", "src/types"],
     "declaration": true,
     "rootDir": "./src",
     "moduleResolution": "node",