Merge branch 'feat/ical-utils' into chore/all-my-stuffs

# Conflicts:
#	package.json
#	pnpm-lock.yaml
#	src/tools/index.ts

Author: sharevb

package.json

@@ -117,6 +117,9 @@
     "iarna-toml-esm": "^3.0.5",
     "ibantools": "^4.3.3",
     "js-base64": "^3.7.7",
+    "ical-generator": "^8.0.0",
+    "ical.js": "^2.1.0",
+    "js-base64": "^3.7.6",
     "json5": "^2.2.3",
     "jwt-decode": "^3.1.2",
     "libphonenumber-js": "^1.10.28",

pnpm-lock.yaml

@@ -0,0 +1,127 @@
+<script setup lang="ts">
+import slugify from '@sindresorhus/slugify';
+import ical, { ICalCalendarMethod } from 'ical-generator';
+import { Base64 } from 'js-base64';
+import { useDownloadFileFromBase64 } from '@/composable/downloadBase64';
+
+interface Event {
+  startend: [number, number]
+  summary?: string
+  description?: string
+  location?: string
+  url?: string
+}
+
+const events = ref<Array<Event>>([{
+  startend: [Date.now(), Date.now()],
+  summary: 'An event',
+}]);
+function deleteEvent(index: number) {
+  if (events.value.length === 1) {
+    return;
+  }
+  events.value.splice(index, 1);
+}
+function addEvent() {
+  const now = Date.now();
+  events.value.push({
+    startend: [now, now + 3600 * 1000],
+    summary: 'An event',
+  });
+}
+
+const output = computed(() => {
+  try {
+    const calendar = ical({ name: events.value[0]?.summary || 'unamed' });
+
+    // A method is required for outlook to display event as an invitation
+    calendar.method(ICalCalendarMethod.REQUEST);
+
+    for (const event of events.value) {
+      calendar.createEvent({
+        start: new Date(event.startend[0]).toUTCString(),
+        end: new Date(event.startend[0]).toUTCString(),
+        summary: event.summary,
+        description: event.description,
+        location: event.location,
+        url: event.url,
+      });
+    }
+
+    return { ical: calendar.toString() };
+  }
+  catch (e: any) {
+    return { error: e.toString() };
+  }
+});
+const outputBase64 = computed(() => Base64.encode(output.value?.ical || ''));
+const customOutputFileName = ref('');
+const outputFileName = computed(() => {
+  if (customOutputFileName.value) {
+    return customOutputFileName.value;
+  }
+
+  return slugify(events.value[0]?.summary || 'unamed');
+});
+const { download } = useDownloadFileFromBase64(
+  {
+    source: outputBase64,
+    filename: outputFileName,
+    extension: 'ics',
+  });
+</script>
+
+<template>
+  <div>
+    <div mb-2 flex items-baseline gap-2>
+      <c-input-text
+        v-model:value="outputFileName"
+        placeholder="Generated if empty"
+        label="Output filename:"
+        label-position="left"
+        mb-2
+      />
+      <c-button v-if="output.ical" @click="download">
+        Download ICS
+      </c-button>
+    </div>
+
+    <c-alert v-if="output.error" mb-2>
+      {{ output.error }}
+    </c-alert>
+
+    <c-card v-for="(event, index) in events" :key="index" mb-2>
+      <n-form-item label="Title:" label-placement="left">
+        <n-input v-model:value="event.summary" :allow-input="(value:string) => !!value" />
+      </n-form-item>
+      <n-form-item label="Dates and hours:" label-placement="left">
+        <n-date-picker v-model:value="event.startend" type="datetimerange" />
+      </n-form-item>
+      <c-input-text
+        v-model:value="event.description"
+        label="Description"
+        placeholder="Put a description here"
+        multiline
+        rows="2"
+        mb-2
+      />
+      <c-input-text
+        v-model:value="event.url"
+        label="Url:"
+        label-position="left"
+        placeholder="Put an url here"
+        mb-2
+      />
+      <div flex justify-center>
+        <c-button @click="deleteEvent(index)">
+          Delete
+        </c-button>
+      </div>
+    </c-card>
+    <div mt-2 flex justify-center>
+      <c-button @click="addEvent">
+        Add Event
+      </c-button>
+    </div>
+  </div>
+</template>

src/tools/ical-generator/ical-generator.vue

@@ -0,0 +1,12 @@
+import { CalendarEvent } from '@vicons/tabler';
+import { defineTool } from '../tool';
+
+export const tool = defineTool({
+  name: 'ICAL Generator',
+  path: '/ical-generator',
+  description: 'Generate ICAL/ICS file from event infos',
+  keywords: ['ical', 'calendar', 'event', 'generator'],
+  component: () => import('./ical-generator.vue'),
+  icon: CalendarEvent,
+  createdAt: new Date('2024-08-15'),
+});

src/tools/ical-generator/index.ts

@@ -0,0 +1,82 @@
+import { describe, expect, it } from 'vitest';
+import { mergeIcals } from './ical-merger.service';
+
+describe('ical-merger', () => {
+  describe('mergeIcals', () => {
+    it('merge correctly', () => {
+      expect(mergeIcals([
+`BEGIN:VCALENDAR
+PRODID:-//xyz Corp//NONSGML PDA Calendar Version 1.0//EN
+VERSION:2.0
+BEGIN:VEVENT
+DTSTAMP:19960704T120000Z
+UID:[email protected]
+ORGANIZER:mailto:[email protected]
+DTSTART:19960918T143000Z
+DTEND:19960920T220000Z
+STATUS:CONFIRMED
+CATEGORIES:CONFERENCE
+SUMMARY:Networld+Interop Conference
+DESCRIPTION:Networld+Interop Conference
+  and Exhibit\\nAtlanta World Congress Center\\n
+ Atlanta\\, Georgia
+END:VEVENT
+END:VCALENDAR`,
+ `BEGIN:VCALENDAR
+METHOD:xyz
+VERSION:2.0
+PRODID:-//ABC Corporation//NONSGML My Product//EN
+BEGIN:VEVENT
+DTSTAMP:19970324T120000Z
+SEQUENCE:0
+UID:[email protected]
+ORGANIZER:mailto:[email protected]
+ATTENDEE;RSVP=TRUE:mailto:[email protected]
+DTSTART:19970324T123000Z
+DTEND:19970324T210000Z
+CATEGORIES:MEETING,PROJECT
+CLASS:PUBLIC
+SUMMARY:Calendaring Interoperability Planning Meeting
+DESCRIPTION:Discuss how we can test c&s interoperability\\n
+ using iCalendar and other IETF standards.
+LOCATION:LDB Lobby
+ATTACH;FMTTYPE=application/postscript:ftp://example.com/pub/
+ conf/bkgrnd.ps
+END:VEVENT
+END:VCALENDAR`,
+      ])).to.eq(
+`BEGIN:VCALENDAR
+PRODID:it-tools-ical-merger
+VERSION:1.0
+BEGIN:VEVENT
+DTSTAMP:19960704T120000Z
+UID:[email protected]
+ORGANIZER:mailto:[email protected]
+DTSTART:19960918T143000Z
+DTEND:19960920T220000Z
+STATUS:CONFIRMED
+CATEGORIES:CONFERENCE
+SUMMARY:Networld+Interop Conference
+DESCRIPTION:Networld+Interop Conference and Exhibit\\nAtlanta World Congress
+  Center\\nAtlanta\\, Georgia
+END:VEVENT
+BEGIN:VEVENT
+DTSTAMP:19970324T120000Z
+SEQUENCE:0
+UID:[email protected]
+ORGANIZER:mailto:[email protected]
+ATTENDEE;RSVP=TRUE:mailto:[email protected]
+DTSTART:19970324T123000Z
+DTEND:19970324T210000Z
+CATEGORIES:MEETING,PROJECT
+CLASS:PUBLIC
+SUMMARY:Calendaring Interoperability Planning Meeting
+DESCRIPTION:Discuss how we can test c&s interoperability\\nusing iCalendar a
+ nd other IETF standards.
+LOCATION:LDB Lobby
+ATTACH;FMTTYPE=application/postscript:ftp://example.com/pub/conf/bkgrnd.ps
+END:VEVENT
+END:VCALENDAR`.replace(/\n/g, '\r\n'));
+    });
+  });
+});

src/tools/ical-merger/ical-merger.service.test.ts

@@ -0,0 +1,45 @@
+import ICAL from 'ical.js';
+
+export function mergeIcals(inputs: Array<string>, options: {
+  calname?: string
+  timezone?: string
+  caldesc?: string
+} = {}) {
+  let calendar;
+  for (const input of inputs) {
+    try {
+      const jcal = ICAL.parse(input);
+      const cal = new ICAL.Component(jcal);
+
+      if (!calendar) {
+        calendar = cal;
+        calendar.updatePropertyWithValue('prodid', 'it-tools-ical-merger');
+        calendar.updatePropertyWithValue('version', '1.0');
+
+        if (options.calname) {
+          calendar.updatePropertyWithValue('x-wr-calname', options.calname);
+        }
+        if (options.timezone) {
+          calendar.updatePropertyWithValue('x-wr-timezone', options.timezone);
+        }
+        if (options.caldesc) {
+          calendar.updatePropertyWithValue('x-wr-caldesc', options.caldesc);
+        }
+      }
+      else {
+        for (const vevent of cal.getAllSubcomponents('vevent')) {
+          calendar.addSubcomponent(vevent);
+        }
+      }
+    }
+    catch (e) {
+      throw new Error(`Failed to merge: ${e}\n\nWith input: ${input}`);
+    }
+  }
+
+  if (!calendar) {
+    throw new Error('No icals parsed successfully');
+  }
+
+  return calendar.toString();
+}