keyframekit 1.2.0 → 1.2.1

package/docs/package.json

@@ -1,22 +0,0 @@
-{
-  "type": "module",
-  "scripts": {
-    "dev": "vitepress dev",
-    "build": "vitepress build",
-    "preview": "vitepress preview",
-    "bump": "npm run reference && npm run playground:bumplib",
-    "reference": "typedoc",
-    "playground:bumplib": "mkdir -p ./docs/public/playground/KeyframeKit && cp -r ../dist ./docs/public/playground/KeyframeKit/"
-  },
-  "dependencies": {
-    "vitepress": "^2.0.0-alpha.16",
-    "vue": "^3.5.28",
-    "@monaco-editor/loader": "^1.7.0"
-  },
-  "devDependencies": {
-    "typedoc": "^0.28.17",
-    "typedoc-plugin-markdown": "^4.10.0",
-    "typedoc-plugin-mdn-links": "^5.1.1",
-    "typedoc-plugin-no-inherit": "^1.6.1"
-  }
-}

package/docs/typedoc/plugin-markdown-mdn-links-fix.js

@@ -1,43 +0,0 @@
-// @ts-check
-
-import { MarkdownThemeContext } from 'typedoc-plugin-markdown';
-import { UnionType } from 'typedoc';
-
-/// https://typedoc-plugin-markdown.org/docs/customization#hooks
-/**
- * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
- */
-export function load(app) {
-
-  app.renderer.markdownHooks.on('page.begin', (context) => {
-
-    context.partials.unionType = (model) => { return unionType(context, model) };
-
-    // console.log(context);
-
-    return '';
-    // return `**Generated using "page.begin" hook**`;
-
-  });
-
-}
-
-/// https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts
-/**
- * @param {MarkdownThemeContext} thiss @param {UnionType} model @returns {string}
- */
-function unionType(
-  thiss,
-  model,
-) {
-  // const useCodeBlocks = thiss.options.getValue('useCodeBlocks');
-  const typesOut = model.types.map((unionType) =>
-    thiss.partials.someType(unionType, { forceCollapse: true }),
-  );
-  /* const shouldFormat =
-    useCodeBlocks &&
-    (typesOut?.join('').length > 70 || typesOut?.join('').includes('\n')); */
-  const md = typesOut.join(` \\| `); // typesOut.join(shouldFormat ? `\n  \\| ` : ` \\| `);
-  // console.log(md);
-  return md; // shouldFormat ? `\n  \\| ` + md : md;
-}

package/docs/typedoc/plugin-markdown-see-also.js

@@ -1,262 +0,0 @@
-// @ts-check
-import { MarkdownPageEvent } from 'typedoc-plugin-markdown';
-import { Reflection, ReflectionKind } from 'typedoc';
-
-/**
- * Recursively collect IDs of all reflections directly referenced by a type node.
- *
- * @param {import('typedoc').SomeType | undefined} type
- * @param {Set<number>} out
- */
-function collectRefIds(type, out) {
-  if (!type) return;
-  switch (type.type) {
-    case 'reference': {
-      const r = type.reflection;
-      if (r) out.add(r.id);
-      for (const a of type.typeArguments ?? []) collectRefIds(a, out);
-      break;
-    }
-    case 'union':
-    case 'intersection':
-      for (const t of type.types ?? []) collectRefIds(t, out);
-      break;
-    case 'array':
-    case 'optional':
-    case 'rest':
-      collectRefIds(type.elementType, out);
-      break;
-    case 'tuple':
-      for (const t of type.elements ?? []) collectRefIds(t, out);
-      break;
-    case 'namedTupleMember':
-      collectRefIds(type.element, out);
-      break;
-    case 'conditional':
-      collectRefIds(type.checkType, out);
-      collectRefIds(type.extendsType, out);
-      collectRefIds(type.trueType, out);
-      collectRefIds(type.falseType, out);
-      break;
-    case 'typeOperator':
-      collectRefIds(type.target, out);
-      break;
-    case 'mapped':
-      collectRefIds(type.parameterType, out);
-      collectRefIds(type.templateType, out);
-      collectRefIds(type.nameType, out);
-      break;
-    case 'predicate':
-      collectRefIds(type.targetType, out);
-      break;
-    case 'query':
-      collectRefIds(type.queryType, out);
-      break;
-    case 'indexedAccess':
-      collectRefIds(type.objectType, out);
-      collectRefIds(type.indexType, out);
-      break;
-    case 'reflection':
-      if (type.declaration) collectRefsInDecl(type.declaration, out);
-      break;
-    default:
-      break;
-  }
-}
-
-/**
- * Collect all referenced reflection IDs within a DeclarationReflection
- * (its own type, signatures, accessors, index signatures, type parameters).
- *
- * @param {import('typedoc').DeclarationReflection} decl
- * @param {Set<number>} out
- */
-function collectRefsInDecl(decl, out) {
-  collectRefIds(decl.type, out);
-
-  for (const sig of decl.signatures ?? []) {
-    collectRefIds(sig.type, out); // return type
-    for (const p of sig.parameters ?? []) collectRefIds(p.type, out);
-    for (const tp of sig.typeParameters ?? []) {
-      collectRefIds(tp.type, out);
-      collectRefIds(tp.default, out);
-    }
-  }
-
-  if (decl.getSignature) collectRefIds(decl.getSignature.type, out);
-  if (decl.setSignature) {
-    collectRefIds(decl.setSignature.type, out);
-    for (const p of decl.setSignature.parameters ?? []) collectRefIds(p.type, out);
-  }
-
-  for (const idx of decl.indexSignatures ?? []) {
-    collectRefIds(idx.type, out);
-    for (const p of idx.parameters ?? []) collectRefIds(p.type, out);
-  }
-
-  for (const tp of decl.typeParameters ?? []) {
-    collectRefIds(tp.type, out);
-    collectRefIds(tp.default, out);
-  }
-}
-
-/**
- * @typedef {object} SeeAlsoEntry
- * @property {Map<number, Set<import('typedoc').DeclarationReflection>>} reverse
- *   Pages/members whose code references the current page's symbol.
- * @property {Map<number, Set<import('typedoc').DeclarationReflection>>} forward
- *   Symbols/pages that the current page's code references.
- */
-
-/**
- * Build see-also maps with two directions computed in a single pass.
- *
- * For every type reference from referrer R (on page P) to symbol S (on page Q):
- *   Reverse — Q's see-also gets R  (the referenced type's page links to whoever uses it)
- *   Forward — P's see-also gets S  (the referrer's page links to the types it uses)
- *
- * @param {import('typedoc').ProjectReflection} project
- * @param {import('typedoc').Router} router
- * @returns {SeeAlsoEntry}
- */
-function buildSeeAlsoMaps(project, router) {
-  /** @type {Map<number, Set<import('typedoc').DeclarationReflection>>} */
-  const reverse = new Map();
-  /** @type {Map<number, Set<import('typedoc').DeclarationReflection>>} */
-  const forward = new Map();
-
-  /** @type {Map<number, import('typedoc').DeclarationReflection>} */
-  const linkTargetMap = new Map();
-  /** @type {Map<number, import('typedoc').DeclarationReflection>} */
-  const pageOwnerMap = new Map();
-
-  for (const target of router.getLinkTargets()) {
-    if (!(target instanceof Reflection)) continue;
-    if (target.isProject()) continue;
-    const decl = /** @type {import('typedoc').DeclarationReflection} */ (target);
-    linkTargetMap.set(decl.id, decl);
-    if (router.hasOwnDocument(target)) {
-      pageOwnerMap.set(decl.id, decl);
-    }
-  }
-
-  /**
-   * Walk up to the nearest Declaration with a URL that isn't a TypeLiteral.
-   * Skips signatures and TypeLiteral (__type) nodes while keeping methods,
-   * properties, constructors, and other user-facing declarations.
-   *
-   * @param {import('typedoc').Reflection} refl
-   * @returns {import('typedoc').DeclarationReflection | undefined}
-   */
-  function findLinkTarget(refl) {
-    /** @type {import('typedoc').Reflection | undefined} */
-    let cursor = refl;
-    while (cursor) {
-      if (cursor instanceof Reflection && linkTargetMap.has(cursor.id)) {
-        if (cursor.isDeclaration() && !cursor.kindOf(ReflectionKind.TypeLiteral)) {
-          return linkTargetMap.get(cursor.id);
-        }
-      }
-      cursor = cursor.parent;
-    }
-    return undefined;
-  }
-
-  /**
-   * Walk up to the nearest page-owning reflection.
-   * @param {import('typedoc').Reflection} refl
-   * @returns {import('typedoc').DeclarationReflection | undefined}
-   */
-  function findPageOwner(refl) {
-    /** @type {import('typedoc').Reflection | undefined} */
-    let cursor = refl;
-    while (cursor) {
-      if (cursor instanceof Reflection && pageOwnerMap.has(cursor.id)) {
-        return pageOwnerMap.get(cursor.id);
-      }
-      cursor = cursor.parent;
-    }
-    return undefined;
-  }
-
-  for (const refl of Object.values(project.reflections)) {
-    if (refl.isProject()) continue;
-    const decl = /** @type {import('typedoc').DeclarationReflection} */ (refl);
-
-    const referrer = findLinkTarget(decl);
-    if (!referrer || referrer.isProject()) continue;
-    const referrerPage = findPageOwner(referrer);
-    if (!referrerPage) continue;
-
-    /** @type {Set<number>} */
-    const refIds = new Set();
-    collectRefsInDecl(decl, refIds);
-
-    for (const refId of refIds) {
-      const refRefl = project.getReflectionById(refId);
-      if (!refRefl) continue;
-      const refTarget = findLinkTarget(refRefl);
-      if (!refTarget) continue;
-      const refPage = findPageOwner(refTarget);
-      if (!refPage || refPage.id === referrerPage.id) continue;
-
-      if (!reverse.has(refPage.id)) reverse.set(refPage.id, new Set());
-      reverse.get(refPage.id)?.add(referrer);
-
-      if (!forward.has(referrerPage.id)) forward.set(referrerPage.id, new Set());
-      forward.get(referrerPage.id)?.add(refTarget);
-    }
-  }
-
-  return { reverse, forward };
-}
-
-// ─── Plugin entry point ───────────────────────────────────────────────────────
-
-/** @param {import('typedoc-plugin-markdown').MarkdownApplication} app */
-export function load(app) {
-
-  /** @type {SeeAlsoEntry} */
-  let seeAlso = { reverse: new Map(), forward: new Map() };
-
-  app.renderer.preMarkdownRenderAsyncJobs.push(async (event) => {
-    const router = app.renderer.router;
-    if (!router || !event.project) return;
-    seeAlso = buildSeeAlsoMaps(event.project, router);
-  });
-
-  app.renderer.markdownHooks.on('page.end', ({ page, router }) => {
-    if (!page.isReflectionEvent()) return '';
-
-    const model = /** @type {import('typedoc').DeclarationReflection} */ (page.model);
-    const reverseRefs = seeAlso.reverse.get(model.id);
-    const forwardRefs = seeAlso.forward.get(model.id);
-    if (!reverseRefs?.size && !forwardRefs?.size) return '';
-
-    const byName = (/** @type {import('typedoc').DeclarationReflection} */ a, /** @type {import('typedoc').DeclarationReflection} */ b) =>
-      a.getFriendlyFullName().localeCompare(b.getFriendlyFullName());
-
-    const seen = new Set();
-    let linksText = '';
-
-    /** @param {import('typedoc').DeclarationReflection} ref */
-    const formatLink = (ref) => {
-      if (ref.id === model.id || seen.has(ref.id)) return;
-      seen.add(ref.id);
-      const url = router.relativeUrl(model, ref);
-      linksText += `\n- [${ref.getFriendlyFullName()}](${url})`;
-    };
-
-    if (forwardRefs) {
-      linksText += '\n### Referenced Here';
-      [...forwardRefs].sort(byName).forEach(formatLink);
-    }
-    if (reverseRefs) {
-      linksText += '\n### References This';
-      [...reverseRefs].sort(byName).forEach(formatLink);
-    }
-
-    if (!linksText) return '';
-    return `\n## See Also\n${linksText}\n`;
-  });
-}

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

@@ -1,17 +0,0 @@
-// @ts-check
-
-import * as td from "typedoc";
-
-/** @param {td.Application} app */
-export function load(app) {
-    app.converter.on(td.Converter.EVENT_CREATE_SIGNATURE, (context, sig) => {
-        if (!sig.parameters) {
-            return;
-        }
-        for (const [i, param] of sig.parameters.entries()) {
-            if (param.name === '__namedParameters') {
-                param.name = 'obj';
-            }
-        }
-    });
-}

package/docs/typedoc.config.js

@@ -1,81 +0,0 @@
-// @ts-check
-
-/**
- * @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions & { inheritNone?: boolean }}
- */
-export default {
-  "name": "KeyframeKit",
-  
-	"plugin": [
-    "typedoc-plugin-markdown",
-    "typedoc-plugin-mdn-links",
-    "typedoc-plugin-no-inherit",
-    "./typedoc/plugin-param-names.js",
-    "./typedoc/plugin-markdown-mdn-links-fix.js",
-    "./typedoc/plugin-markdown-see-also.js",
-    //"typedoc-plugin-inline-sources",
-    //"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
-
-  "entryFileName": "index",
-
-  "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,
-  },
-
-  "inheritNone": true,
-
-  //"pageTitleTemplates": {
-    //"index": "Reference"
-  //},
-
-  //"hideBreadcrumbs": true
-};

package/docs/vercel.json

@@ -1,14 +0,0 @@
-{
-  "cleanUrls": true,
-  "headers": [
-    {
-      "source": "/assets/(.*)",
-      "headers": [
-        {
-          "key": "Cache-Control",
-          "value": "max-age=31536000, immutable"
-        }
-      ]
-    }
-  ]
-}

package/rollup.config.js

@@ -1,42 +0,0 @@
-import typescript from '@rollup/plugin-typescript';
-import terser from '@rollup/plugin-terser';
-
-import MagicString from 'magic-string';
-
-/**
- * @type {import('rollup').RollupOptions}
- */
-export default {
-  input: {
-    'KeyframeKit.min.js': 'src/KeyframeKit.ts'
-  },
-  output: {
-    dir: 'dist',
-    entryFileNames: '[name]'
-  },
-  plugins: [typescript({ sourceMap: false }), terser(), header()]
-};
-
-function header() {
-
-	return {
-
-		renderChunk( code ) {
-
-			code = new MagicString( code );
-
-			code.prepend( `/*
- * KeyframeKit
- * MIT License
- */\n` );
-
-			return {
-				code: code.toString(),
-				map: code.generateMap()
-			};
-
-		}
-
-	};
-
-}

package/tsconfig.default.json

@@ -1,44 +0,0 @@
-{
-  // Visit https://aka.ms/tsconfig to read more about this file
-  "compilerOptions": {
-    // File Layout
-    // "rootDir": "./src",
-    // "outDir": "./dist",
-
-    // Environment Settings
-    // See also https://aka.ms/tsconfig/module
-    "module": "nodenext",
-    "target": "esnext",
-    "types": [],
-    // For nodejs:
-    // "lib": ["esnext"],
-    // "types": ["node"],
-    // and npm install -D @types/node
-
-    // Other Outputs
-    "sourceMap": true,
-    "declaration": true,
-    "declarationMap": true,
-
-    // Stricter Typechecking Options
-    "noUncheckedIndexedAccess": true,
-    "exactOptionalPropertyTypes": true,
-
-    // Style Options
-    // "noImplicitReturns": true,
-    // "noImplicitOverride": true,
-    // "noUnusedLocals": true,
-    // "noUnusedParameters": true,
-    // "noFallthroughCasesInSwitch": true,
-    // "noPropertyAccessFromIndexSignature": true,
-
-    // Recommended Options
-    "strict": true,
-    "jsx": "react-jsx",
-    "verbatimModuleSyntax": true,
-    "isolatedModules": true,
-    "noUncheckedSideEffectImports": true,
-    "moduleDetection": "force",
-    "skipLibCheck": true,
-  }
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.default.json",
-  "module": "esnext",
-  
-  "files": ["src/KeyframeKit.ts"],
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist",
-  }
-}