keyframekit 1.0.0

package/docs/docs/reference/classes/KeyframeEffectParameters.md

@@ -0,0 +1,95 @@
+[KeyframeKit](../index.md) / KeyframeEffectParameters
+
+# Class: KeyframeEffectParameters
+
+https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface
+
+## Constructors
+
+### Constructor
+
+```ts
+new KeyframeEffectParameters(obj: {
+  keyframes: KeyframeArgument;
+  options?: number | KeyframeEffectOptions;
+}): KeyframeEffectParameters;
+```
+
+#### Parameters
+
+##### obj
+
+###### keyframes
+
+[`KeyframeArgument`](../type-aliases/KeyframeArgument.md)
+
+[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats)
+
+###### options?
+
+`number` \| `KeyframeEffectOptions` = `{}`
+
+[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
+
+#### Returns
+
+`KeyframeEffectParameters`
+
+## Properties
+
+### keyframes
+
+```ts
+keyframes: KeyframeArgument;
+```
+
+***
+
+### options
+
+```ts
+options: KeyframeEffectOptions;
+```
+
+## Methods
+
+### toAnimation()
+
+```ts
+toAnimation(obj: {
+  options?: number | KeyframeEffectOptions;
+  target: Element | null;
+  timeline?: AnimationTimeline;
+}): Animation;
+```
+
+#### Parameters
+
+##### obj
+
+###### options?
+
+`number` \| `KeyframeEffectOptions` = `{}`
+
+Additional keyframe effect options. Can override existing keys.
+[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
+
+###### target
+
+[`Element`](https://developer.mozilla.org/docs/Web/API/Element) \| `null`
+
+An element to attach the animation to.
+
+###### timeline?
+
+[`AnimationTimeline`](https://developer.mozilla.org/docs/Web/API/AnimationTimeline) = `document.timeline`
+
+#### Returns
+
+[`Animation`](https://developer.mozilla.org/docs/Web/API/Animation)
+
+#### See
+
+Specifications:
+- https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface
+- https://drafts.csswg.org/web-animations-1/#the-animation-interface

package/docs/docs/reference/classes/ParsedKeyframes.md

@@ -0,0 +1,49 @@
+[KeyframeKit](../index.md) / ParsedKeyframes
+
+# Class: ParsedKeyframes
+
+## Constructors
+
+### Constructor
+
+```ts
+new ParsedKeyframes(keyframes: Keyframe[]): ParsedKeyframes;
+```
+
+#### Parameters
+
+##### keyframes
+
+`Keyframe`[]
+
+#### Returns
+
+`ParsedKeyframes`
+
+## Properties
+
+### keyframes
+
+```ts
+keyframes: Keyframe[];
+```
+
+## Methods
+
+### toKeyframeEffect()
+
+```ts
+toKeyframeEffect(options: number | KeyframeEffectOptions | null): KeyframeEffectParameters;
+```
+
+#### Parameters
+
+##### options
+
+[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
+
+`number` | `KeyframeEffectOptions` | `null`
+
+#### Returns
+
+[`KeyframeEffectParameters`](KeyframeEffectParameters.md)

package/docs/docs/reference/index.md

@@ -0,0 +1,20 @@
+# KeyframeKit
+
+## Classes
+
+- [KeyframeEffectParameters](classes/KeyframeEffectParameters.md)
+- [ParsedKeyframes](classes/ParsedKeyframes.md)
+
+## Interfaces
+
+- [KeyframesFactory](interfaces/KeyframesFactory.md)
+
+## Type Aliases
+
+- [KeyframeArgument](type-aliases/KeyframeArgument.md)
+- [KeyframesFactorySource](type-aliases/KeyframesFactorySource.md)
+- [ParsedKeyframesRules](type-aliases/ParsedKeyframesRules.md)
+
+## Variables
+
+- [default](variables/default.md)

package/docs/docs/reference/interfaces/KeyframesFactory.md

@@ -0,0 +1,151 @@
+[KeyframeKit](../index.md) / KeyframesFactory
+
+# Interface: KeyframesFactory
+
+## Properties
+
+### Error
+
+```ts
+readonly Error: {
+  KeyframesRuleNameTypeError: typeof KeyframesRuleNameTypeError;
+  SourceTypeError: typeof SourceTypeError;
+  StyleSheetImportError: typeof StyleSheetImportError;
+};
+```
+
+#### KeyframesRuleNameTypeError
+
+```ts
+readonly KeyframesRuleNameTypeError: typeof KeyframesRuleNameTypeError;
+```
+
+#### SourceTypeError
+
+```ts
+readonly SourceTypeError: typeof SourceTypeError;
+```
+
+#### StyleSheetImportError
+
+```ts
+readonly StyleSheetImportError: typeof StyleSheetImportError;
+```
+
+## Methods
+
+### getAllStyleSheetKeyframesRules()
+
+```ts
+getAllStyleSheetKeyframesRules(obj: {
+  in: KeyframesFactorySource;
+}): ParsedKeyframesRules;
+```
+
+#### Parameters
+
+##### obj
+
+###### in
+
+[`KeyframesFactorySource`](../type-aliases/KeyframesFactorySource.md)
+
+#### Returns
+
+[`ParsedKeyframesRules`](../type-aliases/ParsedKeyframesRules.md)
+
+***
+
+### getDocumentStyleSheetsOnLoad()
+
+```ts
+getDocumentStyleSheetsOnLoad(obj?: {
+  document?: Document;
+}): Promise<StyleSheetList>;
+```
+
+#### Parameters
+
+##### obj?
+
+###### document?
+
+[`Document`](https://developer.mozilla.org/docs/Web/API/Document) = `window.document`
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`StyleSheetList`](https://developer.mozilla.org/docs/Web/API/StyleSheetList)\>
+
+***
+
+### getStyleSheetKeyframes()
+
+```ts
+getStyleSheetKeyframes(obj: {
+  in: KeyframesFactorySource;
+  of: string;
+}): ParsedKeyframes | undefined;
+```
+
+#### Parameters
+
+##### obj
+
+###### in
+
+[`KeyframesFactorySource`](../type-aliases/KeyframesFactorySource.md)
+
+###### of
+
+`string`
+
+The name of the `@keyframes` rule to get keyframes from.
+
+#### Returns
+
+[`ParsedKeyframes`](../classes/ParsedKeyframes.md) \| `undefined`
+
+***
+
+### importStyleSheet()
+
+```ts
+importStyleSheet(url: string): Promise<CSSStyleSheet>;
+```
+
+#### Parameters
+
+##### url
+
+`string`
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CSSStyleSheet`](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet)\>
+
+#### Remarks
+
+Note: `@import` rules won't be resolved in imported stylesheets.  
+ See https://github.com/WICG/construct-stylesheets/issues/119#issuecomment-588352418.
+
+***
+
+### parseKeyframesRule()
+
+```ts
+parseKeyframesRule(obj: {
+  rule: CSSKeyframesRule;
+}): ParsedKeyframes;
+```
+
+#### Parameters
+
+##### obj
+
+###### rule
+
+[`CSSKeyframesRule`](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule)
+
+#### Returns
+
+[`ParsedKeyframes`](../classes/ParsedKeyframes.md)

package/docs/docs/reference/navigation.json

@@ -0,0 +1,64 @@
+[
+  {
+    "title": "Classes",
+    "children": [
+      {
+        "title": "KeyframeEffectParameters",
+        "kind": 128,
+        "path": "classes/KeyframeEffectParameters.md",
+        "isDeprecated": false
+      },
+      {
+        "title": "ParsedKeyframes",
+        "kind": 128,
+        "path": "classes/ParsedKeyframes.md",
+        "isDeprecated": false
+      }
+    ]
+  },
+  {
+    "title": "Interfaces",
+    "children": [
+      {
+        "title": "KeyframesFactory",
+        "kind": 256,
+        "path": "interfaces/KeyframesFactory.md",
+        "isDeprecated": false
+      }
+    ]
+  },
+  {
+    "title": "Type Aliases",
+    "children": [
+      {
+        "title": "KeyframeArgument",
+        "kind": 2097152,
+        "path": "type-aliases/KeyframeArgument.md",
+        "isDeprecated": false
+      },
+      {
+        "title": "KeyframesFactorySource",
+        "kind": 2097152,
+        "path": "type-aliases/KeyframesFactorySource.md",
+        "isDeprecated": false
+      },
+      {
+        "title": "ParsedKeyframesRules",
+        "kind": 2097152,
+        "path": "type-aliases/ParsedKeyframesRules.md",
+        "isDeprecated": false
+      }
+    ]
+  },
+  {
+    "title": "Variables",
+    "children": [
+      {
+        "title": "default",
+        "kind": 32,
+        "path": "variables/default.md",
+        "isDeprecated": false
+      }
+    ]
+  }
+]

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

@@ -0,0 +1,9 @@
+[KeyframeKit](../index.md) / KeyframeArgument
+
+# Type Alias: KeyframeArgument
+
+```ts
+type KeyframeArgument = Keyframe[] | PropertyIndexedKeyframes;
+```
+
+https://drafts.csswg.org/web-animations-1/#processing-a-keyframes-argument

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

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

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

@@ -0,0 +1,15 @@
+[KeyframeKit](../index.md) / ParsedKeyframesRules
+
+# Type Alias: ParsedKeyframesRules
+
+```ts
+type ParsedKeyframesRules = {
+[ruleName: string]: ParsedKeyframes;
+};
+```
+
+## Index Signature
+
+```ts
+[ruleName: string]: ParsedKeyframes
+```

package/docs/docs/reference/variables/default.md

@@ -0,0 +1,7 @@
+[KeyframeKit](../index.md) / default
+
+# Variable: default
+
+```ts
+default: KeyframesFactory;
+```

package/docs/package.json

@@ -0,0 +1,25 @@
+{
+  "scripts": {
+    "dev": "vitepress dev",
+    "build": "vitepress build",
+    "preview": "vitepress preview",
+    "bump": "npm run reference && npm run playground:bumplib",
+    "reference": "typedoc && rm ./docs/reference/README.md",
+    "playground:bumplib": "mkdir -p ./docs/public/playground/KeyframeKit && cp -r ../dist ./docs/public/playground/KeyframeKit/"
+  },
+  "devDependencies": {
+    "remark-collapse": "^0.1.2",
+    "remark-insert-headings": "^0.0.0",
+    "remark-toc": "^9.0.0",
+    "typedoc": "^0.28.17",
+    "typedoc-plugin-inline-sources": "^1.3.0",
+    "typedoc-plugin-markdown": "^4.10.0",
+    "typedoc-plugin-mdn-links": "^5.1.1",
+    "typedoc-plugin-remark": "^0.0.0",
+    "vitepress": "^2.0.0-alpha.16",
+    "vue": "^3.5.28"
+  },
+  "dependencies": {
+    "@monaco-editor/loader": "^1.7.0"
+  }
+}

package/docs/typedoc/plugin-param-names.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.load = void 0;
+const typedoc_1 = require("typedoc");
+const paramNameOption = 'namedParamName';
+const detectFromCommentsOption = 'detectNamedParamFromComments';
+const changeParamTagOption = 'changeNamedParamTag';
+const load = (app) => {
+    app.options.addDeclaration({
+        name: paramNameOption,
+        help: 'Specifies the name to replace __namedParameters with, if a @param tag isn’t found.',
+        type: typedoc_1.ParameterType.String,
+        defaultValue: 'options'
+    });
+    app.options.addDeclaration({
+        name: detectFromCommentsOption,
+        help: 'Whether to detect the name of parameters from the documentation comments.',
+        type: typedoc_1.ParameterType.Boolean,
+        defaultValue: true
+    });
+    app.options.addDeclaration({
+        name: changeParamTagOption,
+        help: `Whether to change the name of the @param tag to ${paramNameOption} so documentation is shown for a corresponding __namedParameters parameter. Ignored if ${detectFromCommentsOption} is true.`,
+        type: typedoc_1.ParameterType.Boolean,
+        defaultValue: true
+    });
+    let paramName;
+    let detectFromComments;
+    let changeParamTag;
+    app.converter.on(typedoc_1.Converter.EVENT_BEGIN, () => {
+        paramName = app.options.getValue(paramNameOption);
+        detectFromComments = app.options.getValue(detectFromCommentsOption);
+        changeParamTag = app.options.getValue(changeParamTagOption);
+        if (!changeParamTag && detectFromComments) {
+            app.logger.warn(`${changeParamTagOption} is ignored when ${detectFromCommentsOption} is true`);
+        }
+    });
+    app.converter.on(typedoc_1.Converter.EVENT_CREATE_SIGNATURE, (context, sig) => {
+        var _a, _b;
+
+        if (!sig.parameters)
+            return;
+        for (const [i, param] of sig.parameters.entries()) {
+            if (param.name !== '__namedParameters')
+                continue;
+            else {
+                param.name = 'obj';
+            }
+        }
+    });
+};
+exports.load = load;

package/docs/typedoc.json

@@ -0,0 +1,63 @@
+{
+  "name": "KeyframeKit",
+  
+	"plugin": [
+    "./typedoc/plugin-param-names.js",
+    "typedoc-plugin-mdn-links",
+    "typedoc-plugin-inline-sources",
+    "typedoc-plugin-markdown",
+    "typedoc-plugin-remark",
+    //"typedoc-github-wiki-theme",
+    //"typedoc-plugin-missing-exports"
+  ],
+
+  "entryPoints": ["../src/KeyframeKit.ts"],
+  "out": "docs/reference",
+
+  "validation": {
+    "notExported": false
+  },
+
+  //"excludeExternals": true,
+  //"placeInternalsInOwningModule": true,
+
+  "disableSources": true,
+  
+  //"flattenOutputFiles": false,
+
+  "router": "member", // "module"
+
+  //"readme": "none",
+
+  //"sidebar": {
+    //"autoConfiguration": false,
+    //"heading": "[KeyframeKit](../wiki)"
+  //},
+
+  "remarkPlugins": [
+    ["remark-insert-headings", { "text": "Contents", "minHeadingCount": 1 }],
+    ["remark-toc", { "maxDepth": 3, "tight": true }],
+    //["remark-collapse", {"test": "Contents"}]
+  ],
+  
+  "modulesFileName": "index", // KeyframeKit
+
+  "expandParameters": true,
+  "expandObjects": true,
+
+  //"parametersFormat": "htmlTable",
+
+  "useCodeBlocks": true,
+
+  //"hidePageTitle": true,
+  "hidePageHeader": true,
+
+  //"namedParamName": "obj"
+
+  "navigationJson": "docs/reference/navigation.json",
+  "navigation": {
+    "includeCategories": true,
+    "includeGroups": true,
+    "includeFolders": true,
+  }
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "keyframekit",
+  "version": "1.0.0",
+  "description": "Intuitive, powerful and performant tools for working with CSS animations in JavaScript.",
+  "main": "./dist/KeyframeKit.js",
+  "scripts": {
+    "build": "npx tsc",
+    "docs:bump": "(cd docs && npm run bump)",
+    "docs:build": "(cd docs && npm run build)"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/benhatsor/KeyframeKit.git"
+  },
+  "keywords": [
+    "css",
+    "js",
+    "javascript",
+    "animation",
+    "keyframe",
+    "stylesheet",
+    "framework",
+    "tools",
+    "performance",
+    "typescript"
+  ],
+  "author": "Ben Hatsor",
+  "license": "MIT",
+  "types": "./dist/KeyframeKit.d.ts",
+  "bugs": {
+    "url": "https://github.com/benhatsor/KeyframeKit/issues"
+  },
+  "homepage": "https://keyframekit.berryscript.com",
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}