chore: API Extractor (#1964)

Author: tassoevan

.gitignore

@@ -16,3 +16,4 @@ node_modules/
 **/.storybook/jest-results.json
 **/bundle-report.html
 .env
+/packages/*/temp/

.prettierignore

@@ -6,3 +6,4 @@ bundle-report.html
 /.turbo
 /.yarn
 /README.md
+*.api.md

.vscode/settings.json

@@ -6,5 +6,8 @@
   "[pegjs]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "typescript.tsdk": "node_modules/typescript/lib"
+  "js/ts.tsdk.path": "node_modules/typescript/lib",
+  "files.associations": {
+    "api-extractor.json": "jsonc"
+  }
 }

api-extractor.json

@@ -0,0 +1,51 @@
+/**
+ * Shared base config file for API Extractor in the fuselage monorepo.
+ * For more info, please visit: https://api-extractor.com
+ *
+ * Each package should create its own api-extractor.json that extends this file:
+ *
+ *   {
+ *     "extends": "../../api-extractor.json",
+ *     "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts"
+ *   }
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "bundledPackages": [],
+
+  "compiler": {},
+
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/"
+  },
+
+  "docModel": {
+    "enabled": false
+  },
+
+  "dtsRollup": {
+    "enabled": false
+  },
+
+  "tsdocMetadata": {},
+
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    }
+  }
+}

eslint.config.mjs

@@ -14,7 +14,12 @@ import tseslint from 'typescript-eslint';
 
 export default tseslint.config(
   {
-    ignores: ['**/dist/**', '.yarn/**', '**/storybook-static/**'],
+    ignores: [
+      '**/dist/**',
+      '.yarn/**',
+      '**/storybook-static/**',
+      '**/*.api.md',
+    ],
   },
   {
     rules: {

packages/css-in-js/.gitignore

@@ -1 +1,2 @@
 /dist/
+/temp

packages/css-in-js/api-extractor.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "../../api-extractor.json",
+  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts"
+}

packages/css-in-js/css-in-js.api.md

@@ -0,0 +1,45 @@
+## API Report File for "@rocket.chat/css-in-js"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { cssSupports } from '@rocket.chat/css-supports';
+import type { Middleware } from 'stylis';
+
+// Warning: (ae-forgotten-export) The symbol "RuleAttacher" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export const attachRules: RuleAttacher;
+
+// @public (undocumented)
+export const createAnimationName: (content: string) => string;
+
+// @public (undocumented)
+export const createClassName: (content: string) => string;
+
+// @public (undocumented)
+export const css: (slices: TemplateStringsArray, ...values: readonly unknown[]) => cssFn;
+
+// Warning: (ae-forgotten-export) The symbol "Evaluable" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export type cssFn = Evaluable;
+
+export { cssSupports }
+
+// @public (undocumented)
+export const escapeName: (animationOrClassName: string) => string;
+
+// @public (undocumented)
+export const keyframes: (slices: TemplateStringsArray, ...values: unknown[]) => keyframesFn;
+
+// @public (undocumented)
+export type keyframesFn = Evaluable;
+
+// @public (undocumented)
+export const transpile: (selector: string, content: string, middleware?: Middleware) => string;
+
+// (No @packageDocumentation comment for this package)
+
+```

packages/css-in-js/package.json

@@ -30,7 +30,8 @@
     "/logicalProperties"
   ],
   "scripts": {
-    "build": "rollup -c",
+    "build": "rollup -c && api-extractor run --local",
+    ".:build:api": "api-extractor run --local",
     "docs": "typedoc",
     "lint": "lint",
     "lint-and-fix": "lint-and-fix",
@@ -44,6 +45,7 @@
     "stylis": "~4.3.6"
   },
   "devDependencies": {
+    "@microsoft/api-extractor": "~7.58.7",
     "@rollup/plugin-commonjs": "~28.0.9",
     "@rollup/plugin-json": "~6.1.0",
     "@rollup/plugin-node-resolve": "~16.0.3",

packages/css-supports/.gitignore

@@ -1 +1,2 @@
 /dist
+/temp