Cleanup: Remove unnecessary Library folder and keep plug files at root
All checks were successful
Build SilverBullet Plug / build (push) Successful in 31s

This commit is contained in:
2026-02-17 13:45:09 -08:00
parent 62d4ba1006
commit a11c6bd906
947 changed files with 434513 additions and 10 deletions

View File

@@ -0,0 +1 @@
../../../@standard-schema+spec@1.1.0/node_modules/@standard-schema/spec

View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 Neuvernetzung Medienagentur UG
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -0,0 +1,167 @@
# TS-ICS
[![neuvernetzung-logo](https://raw.githubusercontent.com/Neuvernetzung/ts-ics/master/public/Header.png)](https://neuvernetzung.de/?utm_source=github&utm_campaign=ts-ics&utm_id=ts-ics)
[![NPM](https://nodei.co/npm/ts-ics.png)](https://nodei.co/npm/ts-ics/)
This library can parse and create Ics files and provides TypeScript types for easy handling and aims to be fully [RFC 5545](https://www.rfc-editor.org/rfc/rfc5545.html) compliant.
## Motivation
Many of the Ics libraries provide good functionality, but none of them are type safe. This library can parse Ics strings with any validator, thanks to [Standard-Schema](https://github.com/standard-schema/standard-schema).
## Installation
`npm i ts-ics`
## generate
### generateIcsCalendar
```ts
import { generateIcsCalendar, type IcsCalendar } from "ts-ics";
const calendar: IcsCalendar = {...}
const icsCalendarString = generateIcsCalendar(calendar);
```
### generateIcsEvent
```ts
import { generateIcsEvent, type IcsEvent } from "ts-ics";
const event: IcsEvent = {...}
const icsEventString = generateIcsEvent(event);
```
### generate non standard values
Non-standard values must be prefixed with `X-`. Unhandled non-standard values are automatically prefixed and converted to upper case, and the value is converted to a string.
```ts
type NonStandard = { isCustomer: string }
const calendar: IcsCalendar<NonStandard> = {
nonStandard: { isCustomer: "yeah" },
...
};
const calendarString = generateIcsCalendar<NonStandard>(calendar, {
nonStandard: {
isCustomer: { name: "X-IS-CUSTOMER", generate: (v) => ({ value: v }) },
},
});
```
## parse
### IcsCalendar
#### without parsing
```ts
import { convertIcsCalendar, type IcsCalendar } from "ts-ics";
const calendar: IcsCalendar = convertIcsCalendar(undefined, icsCalendarString);
```
#### parse with zod
```ts
import { type IcsCalendar } from "ts-ics";
import { parseIcsCalendar } from "@ts-ics/schema-zod";
const calendarParsed: IcsCalendar = parseIcsCalendar(icsCalendarString);
```
#### provide your own validator
This library uses [Standard-Schema](https://github.com/standard-schema/standard-schema) under the hood, so every schema library that implements the spec can be used.
```ts
import { convertIcsCalendar, type IcsCalendar } from "ts-ics";
import { zIcsCalendar } from "@ts-ics/schema-zod";
const calendar: IcsCalendar = convertIcsCalendar(
zIcsCalendar,
icsCalendarString
);
```
### IcsEvent
#### without parsing
```ts
import { convertIcsEvent, type IcsEvent } from "ts-ics";
const event: IcsEvent = convertIcsEvent(undefined, icsEventString);
```
#### parse with zod
```ts
import { type IcsEvent } from "ts-ics";
import { parseIcsEvent } from "@ts-ics/schema-zod";
const eventParsed: IcsEvent = parseIcsEvent(icsEventString);
```
#### provide your own validator
This library uses [Standard-Schema](https://github.com/standard-schema/standard-schema) under the hood, so every schema library that implements the spec can be used.
```ts
import { convertIcsEvent, type IcsEvent } from "ts-ics";
import { zIcsEvent } from "@ts-ics/schema-zod";
const calendar: IcsEvent = convertIcsEvent(zIcsEvent, icsEventString);
```
### parse non standard values
Non-standard values must be prefixed with `X-`. Unhandled non-standard values are automatically un-prefixed and converted to camel case, and the value is converted to a string.
```ts
const calendarString = `...
X-IS-CUSTOMER:yeah
...`;
const calendar = convertIcsCalendar(undefined, calendarString, {
nonStandard: {
isCustomer: {
name: "X-IS-CUSTOMER",
convert: (line) => line.value,
schema: z.string(), // optionally provide any validator
},
},
});
```
## utils
### extendByRecurrenceRule
```ts
import { extendByRecurrenceRule } from "ts-ics";
const start = new Date(Date.UTC(2023, 9, 5));
const ruleString = "FREQ=DAILY;BYMINUTE=15,16,17,18,19;BYSECOND=0,20,40";
const rule = parseIcsRecurrenceRule(ruleString);
const dates = extendByRecurrenceRule(rule, {
start,
end: addDays(start, 1),
});
```
## License
MIT - [License](https://github.com/Neuvernetzung/ts-ics/blob/master/LICENSE)
## Thanks
Thanks to [iCalendar.org](https://icalendar.org/) for the ics documentation and the many examples which are used for testing purposes.

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,41 @@
{
"name": "ts-ics",
"author": "Neuvernetzung Medienagentur UG",
"version": "2.4.0",
"description": "Create and parse ICS format for TypeScript",
"type": "module",
"main": "dist/index.cjs",
"module": "dist/index.js",
"scripts": {
"lint": "npx @biomejs/biome lint ./src --write",
"type-check": "tsc --noEmit",
"dev": "tsup --watch",
"build": "tsup",
"test": "jest"
},
"license": "MIT",
"dependencies": {
"@standard-schema/spec": "^1.0.0"
},
"devDependencies": {
"@testing-library/jest-dom": "^6.8.0",
"@biomejs/biome": "^2.2.4",
"@types/jest": "^30.0.0",
"@types/node": "^24.5.1",
"date-fns": "^4.1.0",
"jest": "^30.1.3",
"jest-environment-jsdom": "^30.1.2",
"jest-environment-node": "^30.1.2",
"ts-jest": "^29.4.2",
"ts-node": "^10.9.2",
"tsup": "^8.5.0",
"typescript": "^5.9.2"
},
"repository": {
"type": "git",
"url": "https://github.com/Neuvernetzung/ts-ics.git"
},
"publishConfig": {
"access": "public"
}
}