timezones-ical-library 1.2.0 → 1.3.0

package/.eslintrc.json

@@ -0,0 +1,39 @@
+{
+  "root": true,
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:security/recommended",
+    "prettier"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "xss/no-mixed-html": [
+      2,
+      {
+        "functions": {
+          ".encodeURIComponent": {
+            "passthrough": { "obj": true, "args": true }
+          }
+        }
+      }
+    ]
+  },
+  "plugins": ["@typescript-eslint"],
+  "ignorePatterns": [
+    "*.min.*",
+    "Gruntfile.js",
+    "zonesdb.js",
+    "generator.js",
+    "set-release.js",
+    "npm_dist/",
+    "dist/"
+  ],
+  "rules": {}
+}

package/.prettierignore

@@ -0,0 +1,8 @@
+# Ignore html files
+*.html
+
+# Ignore css files
+*.css
+
+# Ignore minified files
+*.min.*

package/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "proseWrap": "preserve",
+  "printWidth": 110,
+  "embeddedLanguageFormatting": "off",
+  "useTabs": false,
+  "singleQuote": true,
+  "arrowParens": "always"
+}

package/.stylelintrc.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["stylelint-config-standard", "stylelint-config-prettier"],
+  "ignoreFiles": ["**/*.min.css"],
+  "rules": {
+    "selector-class-pattern": null,
+    "property-no-vendor-prefix": null
+  }
+}

package/Readme.md

@@ -4,7 +4,7 @@
 
 # Add to Calendar TimeZones iCal Library
 
-The tool to convert the [IANA (formerly Olson) timezone database files](http://www.iana.org/time-zones) into VTIMEZONE blocks, compatible with the iCalendar specification (RFC2445).
+The tool to convert the [IANA (formerly Olson) time zone database files](http://www.iana.org/time-zones) into VTIMEZONE blocks, compatible with the iCalendar specification (RFC2445).
 
 It is based on the awesome tool by Damon Chaplin ([github.com/libical/vzic](https://github.com/libical/vzic)), but only provides the VTIMEZONE part to easily put this into any other iCal generator (like the [add-to-calendar-button](https://github.com/add2cal/add-to-calendar-button)). It is built to be used standalone or as JavaScript module, hosted as npm package.
 
@@ -18,37 +18,28 @@ It is based on the awesome tool by Damon Chaplin ([github.com/libical/vzic](http
 
 ### 0. Update it (not required)
 
-**This step is only relevant if you want to build the package and data from source!** 
-*(Requires Node.js as well as Linux as operating system.)* 
+**This step is only relevant if you want to build the package and data on your own and from source!**
+_(Requires Node.js as well as Linux as operating system.)_
 Run ...
 
 ```
 sudo sh update-tzdata.sh tzVersionNumber
 ```
 
-... with *tzVersionNumber* being the version of the IANA timezone database you want to use (e.g. sudo sh update-tzdata.sh 2022c).
+... with _tzVersionNumber_ being the version of the IANA time zone database you want to use (e.g. sudo sh update-tzdata.sh 2022d).
 
 <br />
 
 ### 1. Load it
 
-#### A. VanillaJS
-
-You can use the pure and simple version directly from the dist folder or the jsDelivr CDN and include in your application:
-
-```
-<script src="https://cdn.jsdelivr.net/npm/timezones-ical-library"></script>
-```
-
-#### B. npm package
-
-Alternatively, you can install the package via npm with:
+Install the package via npm with:
 
 ```
 npm install timezones-ical-library
 ```
 
 After the installation:
+
 - require the package (commonJS) or ...
 - import the module (ES) via `import { tzlib_get_ical_block, tzlib_get_offset, tzlib_get_timezones } from 'timezones-ical-library';`.
 
@@ -56,13 +47,13 @@ After the installation:
 
 ### 2. Use it
 
-#### A. Get timezones
+#### A. Get time zones
 
-Use `tzlib_get_timezones()` to retrieve a list of all available timezone strings. You can pass `true` to retrieve a JSON formatted string instead of an array.
+Use `tzlib_get_timezones()` to retrieve a list of all available time zone strings. You can pass `true` to retrieve a JSON formatted string instead of an array.
 
-#### B. Get the iCal timezone block
+#### B. Get the iCal time zone block
 
-Use the `tzlib_get_ical_block(tzName)` function to return the proper iCal VTIMEZONE block for a given timezone string (tzName). Again, pass `true` to retrieve a JSON formatted string instead of an array (not recommended).
+Use the `tzlib_get_ical_block(tzName)` function to return the proper iCal VTIMEZONE block for a given time zone string (tzName). Again, pass `true` to retrieve a JSON formatted string instead of an array (not recommended).
 
 You will receive an array, holding the VTIMEZONE block first, and the TZID line (additionally) second. The latter one is needed for any further time statement.
 
@@ -79,7 +70,7 @@ CALSCALE:GREGORIAN
 
 ```
 BEGIN:VTIMEZONE
-TZID:/timezones-ical-library/20220824/America/New_York
+TZID:America/New_York
 LAST-MODIFIED:20220824T133813Z
 X-LIC-LOCATION:America/New_York
 BEGIN:DAYLIGHT
@@ -103,8 +94,8 @@ END:VTIMEZONE
 BEGIN:VEVENT
 UID:2022-08-30T19:29:38.618Z@add-to-calendar-button
 DTSTAMP:20230214T091500Z
-DTSTART;TZID=/timezones-ical-library/20220824/America/New_York:20230214T091500
-DTEND;TZID=/timezones-ical-library/20220824/America/New_York:20230218T223000
+DTSTART;TZID=America/New_York:20230214T091500
+DTEND;TZID=America/New_York:20230218T223000
 SUMMARY:A sample event
 DESCRIPTION:Just some descriptive text...
 LOCATION:World Wide Web
@@ -119,7 +110,34 @@ END:VCALENDAR
 
 Use `tzlib_get_offset(tzName, isoDate, isoTime)` to get specific offset (relative to UTC), based on a provided date and time.
 
-For example, you can provide *tzName* `'Europe/Berlin'`, *isoDate* `'2023-05-23'`, and *isoTime* `'15:45'` in order to retrieve the offset, which applies for this timezone at the 23rd of May in 2023 at exactly 15:45.
+For example, you can provide _tzName_ `'Europe/Berlin'`, _isoDate_ `'2023-05-23'`, and _isoTime_ `'15:45'` in order to retrieve the offset, which applies for this time zone at the 23rd of May in 2023 at exactly 15:45.
+
+<br /><br />
+
+---
+
+<br />
+
+## ⚙️ API
+
+Instead of using this code or the npm package, you could also make use of the free and open API.
+
+### Getting a list of all zone names
+
+```
+https://tz.add-to-calendar-technology.com/api/zones.json
+```
+
+### Getting the ics part of a respective zone
+
+```
+https://tz.add-to-calendar-technology.com/api/%zoneName%.ics
+```
+
+With %zoneName% being your time zone. So, for New York, this would be [https://tz.add-to-calendar-technology.com/api/America/New_York.ics](https://tz.add-to-calendar-technology.com/api/America/New_York.ics).
+**This is case sensitive!**
+
+(Mind that this does not deliver a fully valid ics file, since it only contains the VTIMEZONE part. You will need to combine this with your other event information.)
 
 <br /><br />
 
@@ -145,6 +163,8 @@ Licensed under [Apache-2.0](LICENSE).
 
 ## ⚡ Changelog (without minor changes and fixes)
 
+- v1.3 : bundle size optimization and API
+- v1.2 : providing tzblock as array with separate tzid
 - v1.1 : get-offset function
 - v1.0 : initial release
 
@@ -154,7 +174,7 @@ Licensed under [Apache-2.0](LICENSE).
 
 ## 💜 Kudos go to
 
-* The ["Time Zone King"](https://samueli.ucla.edu/time-zone-king-how-one-ucla-computer-scientist-keeps-digital-clocks-ticking/) [Paul Eggert](https://github.com/eggert) for optimizing timezones for the web, ...
-* as well as all the contributors at [the official tz repository](https://github.com/eggert/tz).
-* The awesome authors of zic and [vzic](https://github.com/libical/vzic/graphs/contributors); mainly Damon Chaplin, [Allen Winter](https://github.com/winterz), and [Ken Murchison](https://github.com/ksmurchison).
-* [Trevor Eyre](https://github.com/trevoreyre) for his smooth and beautiful [autocomplete script](https://github.com/trevoreyre/autocomplete).
+- The ["Time Zone King"](https://samueli.ucla.edu/time-zone-king-how-one-ucla-computer-scientist-keeps-digital-clocks-ticking/) [Paul Eggert](https://github.com/eggert) for optimizing time zones for the web, ...
+- as well as all the contributors at [the official tz repository](https://github.com/eggert/tz).
+- The awesome authors of zic and [vzic](https://github.com/libical/vzic/graphs/contributors); mainly Damon Chaplin, [Allen Winter](https://github.com/winterz), and [Ken Murchison](https://github.com/ksmurchison).
+- [Trevor Eyre](https://github.com/trevoreyre) for his smooth and beautiful [autocomplete script](https://github.com/trevoreyre/autocomplete).