Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make domain optional #209

Merged
merged 2 commits into from
Aug 12, 2020
Merged

Conversation

rubys
Copy link
Contributor

@rubys rubys commented Aug 11, 2020

The current documentation suggests that a calendar's hostname defaults to your server's hostname. This is not the case. If no domain is provided, ids are currently generated with an @unspecified suffix. This doesn't seem particularly useful or recommended, as appending @unspecified won't help make ids unique.

Appending a domain, while convenient and useful for a number of common uses, interferes other use cases. In my case, I want to be able to round-trip data from iCalendar format to JSON, so my inputs may already have domains present. Another use case is people who want to generated feeds with UUIDs.

This pull request adjusts the documentation to describe how you can construct feeds with either your server's hostname or with UUIDs, and adjusts the code and tests to treat calendar domains as optional.

@sebbo2002 sebbo2002 merged commit e3362c9 into sebbo2002:develop Aug 12, 2020
@sebbo2002
Copy link
Owner

@rubys Thank you very much for your next Pull Request. I almost feel a bit bad because I currently have so little time for this project, so I think it's really wonderful that something is happening here anyway. ❤️

Just released a new version ical-generator@1.13.0 with your changes.

sebbo2002 pushed a commit that referenced this pull request Feb 27, 2021
# [1.3.0-develop.1](v1.2.1...v1.3.0-develop.1) (2021-02-27)

### Bug Fixes

* **package.json:** add temporary version ([0bc117e](0bc117e))
* allow X-attrs to be specified in constructor ([#185](#185)) ([58c1ae5](58c1ae5))
* capitalize byDay even when bySetPos is used ([#205](#205)) ([5440fbc](5440fbc))
* **Typings:** Fix OPT-PARTICIPANT ([b777f9e](b777f9e)), closes [#192](#192)
* Fix scale type for CalendarData ([#191](#191)) ([d5421e8](d5421e8))
* Make x key optional in types ([#211](#211)) ([e3c21e2](e3c21e2))
* Type fixes and updates ([#217](#217)) ([d8abe4d](d8abe4d))

### Features

* **Events:** Add appleLocation method ([#170](#170)) ([0956ba2](0956ba2))
* Add missing string input options to interface ([#199](#199)) ([a963178](a963178))
* Add Transparency Method ([bd2901d](bd2901d))
* Increase id entropy - Fixes [#200](#200) ([#202](#202)) ([6711b0a](6711b0a))
* make domain optional ([#209](#209)) ([e3362c9](e3362c9))
* Updated the entire codebase to Typescript ([d013dc0](d013dc0))
* **Events:** use provided timezone when constructing repeating.exclude ([#210](#210)) ([bd84230](bd84230))
@sebbo2002
Copy link
Owner

🎉 This PR is included in version 1.3.0-develop.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

This was referenced Apr 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants