fix: add global var typings for flowplayer umd;

flowplayer.d.ts

@@ -0,0 +1,4 @@
+import {type FlowplayerUMD} from "@flowplayer/player"
+declare global {
+  var flowplayer: FlowplayerUMD;
+}

package.json

@@ -2,7 +2,7 @@
   "name": "@flowplayer/components",
   "packageManager": "[email protected]",
   "scripts": {
-    "gen:component": "tsx code-gen/bin.ts"
+    "new:component": "tsx tooling/code-gen/bin.ts"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",
@@ -11,7 +11,9 @@
     "inquirer": "^9.2.16",
     "mustache": "^4.2.0",
     "tsx": "^4.7.1",
-    "turbo": "^1.12.4"
+    "turbo": "^1.12.4",
+    "typescript": "latest",
+    "typescript-plugin-css-modules": "^5.1.0"
   },
   "workspaces": [
     "packages/*"

packages/fancy-ui/index.ts

@@ -0,0 +1,11 @@
+export class FancyUi extends HTMLElement {
+  constructor () {
+    super()
+  }
+}
+
+// handle cdn installs
+if (typeof window !== "undefined" && typeof flowplayer !== "undefined") {
+  window.customElements.define("fancy-ui", FancyUi)
+  window.flowplayer.customElements.set("flowplayer-ui", "fancy-ui")
+}

packages/fancy-ui/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@flowplayer/components-fancy-ui",
+  "main": "./index.ts",
+  "description": "it's new and fancy",
+  "flowplayer": {
+    "componentName": "fancy-ui"
+  }
+}

code-gen/prompt.ts → tooling/code-gen/prompt.ts

@@ -2,6 +2,7 @@ import inquirer, {type Question} from 'inquirer'
 import { validComponentNames } from "./flowplayer.helpers"
 import {globby} from "globby"
 import fs from "fs/promises"
+import { packages } from "../utils/packages"
 
 const createComponentClassName = (newComponentName : string) => {
   const parts = newComponentName.split("-")
@@ -14,22 +15,22 @@ const ensureValidWebComponentName = (newComponentName : string)=> {
 }
 
 const isNotUnique = async (input : string)=> {
-  const packageFiles = await globby("packages/*/package.json")
-  for (const f of packageFiles) {
-    const pkg = await fs.readFile(f).then(c => JSON.parse(c.toString()))
+  const packageFiles = await packages()
+  for (const pkg of packageFiles) {
     if (pkg.flowplayer.componentName == input) return true
   }
-
   return false
 }
 
+
 export type ComponentInfo = {
   flowplayerComponentName: string;
   newComponentHTMLName: string;
   newComponentClassName: string;
+  description: string;
 }
 
-export async function prompt () : ComponentInfo {
+export async function prompt () : Promise<ComponentInfo> {
   const componentNames = await validComponentNames()
   const answers = await inquirer.prompt([
     {
@@ -51,10 +52,15 @@ export async function prompt () : ComponentInfo {
         return true
       },
     },
+    {
+      name: "description",
+      message: "please write a short description of the new component:"
+    }
   ])
   return {
     flowplayerComponentName: answers.flowplayerComponentName, 
     newComponentHTMLName: ensureValidWebComponentName(answers.newComponentHTMLName),
-    newComponentClassName: createComponentClassName(answers.newComponentHTMLName)
+    newComponentClassName: createComponentClassName(answers.newComponentHTMLName),
+    description: answers.description,
   }
 }

code-gen/templates/package.eta → tooling/code-gen/templates/package.eta

@@ -1,6 +1,7 @@
 {
   "name": "@flowplayer/components-<%~ it.newComponentHTMLName %>",
   "main": "./index.ts",
+  "description": "<%~ it.description %>",
   "flowplayer": {
     "componentName": "<%~ it.newComponentHTMLName %>"
   }

tooling/utils/packages.ts

@@ -0,0 +1,18 @@
+import { globby } from "globby";
+import fs from "fs/promises"
+
+export type FlowplayerComponentPackage = 
+  { name: string
+  ; description: string
+  ; flowplayer: {componentName: string}
+  }
+
+export async function packages () : Promise<FlowplayerComponentPackage[]> {
+  return globby("packages/*/package.json")
+    .then(packages => Promise
+      .all(packages
+        .map(pkg => fs.readFile(pkg)
+          .then(contents => JSON.parse(contents.toString()))
+        ))
+    )
+}

tsconfig.json

@@ -0,0 +1,112 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+    "plugins": [{ "name": "typescript-plugin-css-modules" }],
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    "types": [
+      //"@flowplayer/player",
+      "./flowplayer.d.ts"
+    ],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}