keyframekit 1.1.3 → 1.1.5

package/src/KeyframeKit.ts

@@ -14,23 +14,32 @@ const CHARS = {
 } as const;
 
 
-export type KeyframesFactorySource = StyleSheetList | CSSStyleSheet;
+export type CSSStyleSheetSource = CSSStyleSheet | StyleSheetList;
 
 class KeyframesFactory {
 
   readonly Error = {
+    /** Keyframes rule name must be a string. */
     KeyframesRuleNameTypeError: class KeyframesRuleNameTypeError extends TypeError {
       message = `Keyframes rule name must be a string.`;
     },
+    /** Source must be either a `CSSStyleSheet` or a `StyleSheetList`. */
     SourceTypeError: class SourceTypeError extends TypeError {
-      message = `Source must be either a Document, a ShadowRoot or a CSSStyleSheet instance.`;
+      message = `Source must be either a CSSStyleSheet or a StyleSheetList.`;
     },
+    /** The stylesheet could not be imported. */
     StyleSheetImportError: class StyleSheetImportError extends Error {
       message = `The stylesheet could not be imported.`;
     }
   } as const;
 
 
+  /**
+   * Gets a document's stylesheets when it loads,
+   * or immediately returns them if it's already loaded.
+   * @param obj
+   * @param obj.document The document to get stylesheets from.
+   */
   async getDocumentStyleSheetsOnLoad({ document = window.document }: {
     document?: Document
   } = {}) {
@@ -44,9 +53,13 @@ class KeyframesFactory {
   }
 
   
-  /** @remarks
+  /**
+   * Imports a stylesheet from a URL.
+   * @param url The URL of the stylesheet to import.
+   * @remarks
    *  Note: `@import` rules won't be resolved in imported stylesheets.  
-   *  See https://github.com/WICG/construct-stylesheets/issues/119#issuecomment-588352418. */
+   *  See https://github.com/WICG/construct-stylesheets/issues/119#issuecomment-588352418.
+   */
   async importStyleSheet(url: string) {
 
     const resp = await fetch(url);
@@ -71,10 +84,16 @@ class KeyframesFactory {
   }
   
   
-  /** @param obj.of The name of the `@keyframes` rule to get keyframes from. */
+  /**
+   * Gets a CSS keyframes rule from a stylesheet or stylesheet list,
+   * then converts it to Web Animations API keyframes.
+   * @param obj
+   * @param obj.of The name of the `@keyframes` rule to get keyframes from.
+   * @param obj.in The stylesheet or stylesheet list where the rule resides.
+   */
   getStyleSheetKeyframes({ of: ruleName, in: source }: {
     of: string,
-    in: KeyframesFactorySource
+    in: CSSStyleSheetSource
   }): ParsedKeyframes | undefined {
 
     if (typeof ruleName !== 'string') {
@@ -149,8 +168,14 @@ class KeyframesFactory {
   }
 
 
+  /**
+   * Gets all the CSS keyframes rules in a stylesheet or stylesheet list,
+   * then converts them to Web Animations API keyframes.
+   * @param obj 
+   * @param obj.in The style sheet or style sheet list to get keyframes from.
+   */
   getAllStyleSheetKeyframesRules({ in: source }: {
-    in: KeyframesFactorySource
+    in: CSSStyleSheetSource
   }): ParsedKeyframesRules {
 
     if (source instanceof StyleSheetList) {
@@ -221,6 +246,11 @@ class KeyframesFactory {
   }
 
 
+  /**
+   * Converts a CSS keyframes rule to Web Animations API keyframes.
+   * @param obj
+   * @param obj.rule The rule to convert.
+   */
   parseKeyframesRule({ rule: keyframes }: {
     rule: CSSKeyframesRule
   }): ParsedKeyframes {
@@ -355,6 +385,7 @@ export class KeyframeEffectParameters {
   options: KeyframeEffectOptions;
 
   /**
+   * @param obj
    * @param obj.keyframes [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats)
    * @param obj.options [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
    */
@@ -367,9 +398,11 @@ export class KeyframeEffectParameters {
   }
 
   /** 
+   * @param obj
    * @param obj.target An element to attach the animation to.
    * @param obj.options Additional keyframe effect options. Can override existing keys.
-   * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
+   *  [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
+   * @param obj.timeline [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Animation/Animation#timeline)
    * 
    * @see Specifications:
    * - https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface
@@ -378,7 +411,7 @@ export class KeyframeEffectParameters {
   toAnimation({ target, options: additionalOptions = {}, timeline = document.timeline }: {
     target: Element | null,
     options?: number | KeyframeEffectOptions,
-    timeline?: AnimationTimeline
+    timeline?: AnimationTimeline | null
   }): Animation {
 
     additionalOptions = this.#parseOptionsArg(additionalOptions);
@@ -477,7 +510,6 @@ function removeSuffix({ of: string, suffix }: {
 
 }
 
-
 async function waitForDocumentLoad({ document }: {
   document: Document
 }) {

package/vercel.json

@@ -1,4 +1,5 @@
 {
+  "cleanUrls": true,
   "headers": [
     {
       "source": "/assets/(.*)",

package/docs/docs/reference/_media/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Ben Hatsor
-
-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.

package/docs/docs/reference/type-aliases/KeyframesFactorySource.md

@@ -1,9 +0,0 @@
-[KeyframeKit](../index.md) / KeyframesFactorySource
-
-# Type Alias: KeyframesFactorySource
-
-```ts
-type KeyframesFactorySource = 
-  | StyleSheetList
-  | CSSStyleSheet;
-```