@najemi-software/typed-scss-modules 13.3.0 → 13.4.0-alpha.52.1

package/esm/core/alerts.d.ts

@@ -1,4 +1,10 @@
+/**
+ * @public
+ */
 export declare const LOG_LEVELS: readonly ["verbose", "error", "info", "silent"];
+/**
+ * @public
+ */
 export type LogLevel = (typeof LOG_LEVELS)[number];
 export declare const logLevelDefault: LogLevel;
 export declare const setAlertsLogLevel: (logLevel: LogLevel) => void;

package/esm/core/alerts.js

@@ -1,4 +1,7 @@
 import chalk from "chalk";
+/**
+ * @public
+ */
 export const LOG_LEVELS = ["verbose", "error", "info", "silent"];
 export const logLevelDefault = "verbose";
 let currentLogLevel;

package/esm/core/types.d.ts

@@ -1,6 +1,12 @@
 import type { SASSOptions } from "../sass/file-to-class-names.js";
 import type { ExportType, LogLevel, QuoteType } from "../typescript/index.js";
-type CLIOnlyOptions = Extract<keyof SASSOptions, "importer">;
+/**
+ * @public
+ */
+export type CLIOnlyOptions = Extract<keyof SASSOptions, "importer">;
+/**
+ * @public
+ */
 export interface CLIOptions extends Exclude<SASSOptions, CLIOnlyOptions> {
     banner: string;
     ignore: string[];
@@ -16,6 +22,8 @@ export interface CLIOptions extends Exclude<SASSOptions, CLIOnlyOptions> {
     outputFolder: string | null;
     allowArbitraryExtensions: boolean;
 }
+/**
+ * @public
+ */
 export interface ConfigOptions extends CLIOptions, SASSOptions {
 }
-export {};

package/esm/implementations/implementations.d.ts

@@ -1,12 +1,16 @@
 import sass, { AsyncCompiler as SassAsyncCompiler, Compiler as SassCompiler } from "sass";
 import sassEmbedded, { AsyncCompiler as SassEmbeddedAsyncCompiler, Compiler as SassEmbeddedCompiler } from "sass-embedded";
 /**
+ * @public
  * A list of all possible SASS package implementations that can be used to
  * perform the compilation and parsing of the SASS files. The expectation is
  * that they provide a nearly identical API so they can be swapped out but
- * all of the same logic can be reused.
+ * all the same logic can be reused.
  */
 export declare const IMPLEMENTATIONS: readonly ["sass", "sass-embedded"];
+/**
+ * @public
+ */
 export type Implementations = (typeof IMPLEMENTATIONS)[number];
 export type Implementation = typeof sass | typeof sassEmbedded;
 export type SyncCompiler = SassCompiler | SassEmbeddedCompiler;

package/esm/implementations/implementations.js

@@ -1,10 +1,11 @@
 import sass, { AsyncCompiler as SassAsyncCompiler, Compiler as SassCompiler } from "sass";
 import sassEmbedded, { AsyncCompiler as SassEmbeddedAsyncCompiler, Compiler as SassEmbeddedCompiler, } from "sass-embedded";
 /**
+ * @public
  * A list of all possible SASS package implementations that can be used to
  * perform the compilation and parsing of the SASS files. The expectation is
  * that they provide a nearly identical API so they can be swapped out but
- * all of the same logic can be reused.
+ * all the same logic can be reused.
  */
 export const IMPLEMENTATIONS = ["sass", "sass-embedded"];
 /**

package/esm/index.d.ts

@@ -1,3 +1,6 @@
-export type { ConfigOptions } from "./core/types.js";
+export type { CLIOnlyOptions, CLIOptions, ConfigOptions } from "./core/types.js";
+export { LOG_LEVELS, type ExportType, type LogLevel, type QuoteType } from "./typescript/index.js";
+export type { InternalSassOptions, SASSOptions } from "./sass/file-to-class-names.js";
+export type { Aliases, Importer, SASSImporterOptions, SyncMode } from "./sass/importer.js";
 export { IMPLEMENTATIONS, type Implementations } from "./implementations/implementations.js";
 export { main as default } from "./main.js";

package/esm/index.js

@@ -1,2 +1,3 @@
+export { LOG_LEVELS } from "./typescript/index.js";
 export { IMPLEMENTATIONS } from "./implementations/implementations.js";
 export { main as default } from "./main.js";

package/esm/main.d.ts

@@ -1,2 +1,5 @@
 import { type CLIOptions } from "./core/index.js";
+/**
+ * @public
+ */
 export declare const main: (pattern: string, cliOptions: Partial<CLIOptions>) => Promise<void>;

package/esm/main.js

@@ -4,6 +4,9 @@ import slash from "slash";
 import { generate, listDifferent, setAlertsLogLevel, watch } from "./core/index.js";
 import { disposeAllCompilers } from "./implementations/compilers.js";
 import { loadConfig, mergeOptions } from "./load.js";
+/**
+ * @public
+ */
 export const main = async (pattern, cliOptions) => {
     const configOptions = await loadConfig();
     const options = mergeOptions(cliOptions, configOptions);

package/esm/sass/file-to-class-names.d.ts

@@ -14,7 +14,13 @@ declare const transformersMap: {
 type NameFormatWithTransformer = keyof typeof transformersMap;
 export declare const NAME_FORMATS: readonly [...("camel" | "dashes" | "kebab" | "none" | "param" | "snake")[], "all"];
 export type NameFormat = (typeof NAME_FORMATS)[number];
+/**
+ * @public
+ */
 export type InternalSassOptions = Pick<Options<SyncMode>, "style" | "loadPaths" | "silenceDeprecations">;
+/**
+ * @public
+ */
 export interface SASSOptions extends SASSImporterOptions, InternalSassOptions {
     nameFormat?: string | string[];
     implementation: Implementations;

package/esm/sass/importer.d.ts

@@ -1,8 +1,17 @@
 import type { FileImporter, Importer as SassImporter } from "sass";
+/**
+ * @public
+ */
 export type SyncMode = "sync" | "async";
-type Importer<TSync extends SyncMode = "sync"> = SassImporter<TSync> | FileImporter<TSync>;
+/**
+ * @public
+ */
+export type Importer<TSync extends SyncMode = "sync"> = SassImporter<TSync> | FileImporter<TSync>;
 type AsyncImporter = Importer<"async">;
 export type { AsyncImporter as SASSAsyncImporter, Importer as SASSImporter };
+/**
+ * @public
+ */
 export interface Aliases {
     [index: string]: string;
 }
@@ -15,6 +24,9 @@ interface AliasImporterOptions {
  */
 export declare const aliasResolver: ({ aliases, aliasPrefixes }: AliasImporterOptions) => (url: string) => string | null;
 export declare const aliasImporter: <TSync extends SyncMode = "sync">({ aliases, aliasPrefixes, }: AliasImporterOptions) => FileImporter<TSync>;
+/**
+ * @public
+ */
 export interface SASSImporterOptions {
     aliases?: Aliases;
     aliasPrefixes?: Aliases;

package/esm/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.58.9"
+    }
+  ]
+}

package/esm/typed-scss-modules.d.ts

@@ -0,0 +1,116 @@
+import type { FileImporter } from 'sass';
+import type { Importer as Importer_2 } from 'sass';
+import { Options } from 'sass';
+
+/**
+ * @public
+ */
+export declare interface Aliases {
+    [index: string]: string;
+}
+
+/**
+ * @public
+ */
+export declare type CLIOnlyOptions = Extract<keyof SASSOptions, "importer">;
+
+/**
+ * @public
+ */
+export declare interface CLIOptions extends Exclude<SASSOptions, CLIOnlyOptions> {
+    banner: string;
+    ignore: string[];
+    ignoreInitial: boolean;
+    exportType: ExportType;
+    exportTypeName: string;
+    exportTypeInterface: string;
+    listDifferent: boolean;
+    quoteType: QuoteType;
+    updateStaleOnly: boolean;
+    watch: boolean;
+    logLevel: LogLevel;
+    outputFolder: string | null;
+    allowArbitraryExtensions: boolean;
+}
+
+/**
+ * @public
+ */
+export declare interface ConfigOptions extends CLIOptions, SASSOptions {
+}
+
+/**
+ * @public
+ */
+export declare type ExportType = "named" | "default";
+
+/**
+ * @public
+ * A list of all possible SASS package implementations that can be used to
+ * perform the compilation and parsing of the SASS files. The expectation is
+ * that they provide a nearly identical API so they can be swapped out but
+ * all the same logic can be reused.
+ */
+export declare const IMPLEMENTATIONS: readonly ["sass", "sass-embedded"];
+
+/**
+ * @public
+ */
+export declare type Implementations = (typeof IMPLEMENTATIONS)[number];
+
+/**
+ * @public
+ */
+export declare type Importer<TSync extends SyncMode = "sync"> = Importer_2<TSync> | FileImporter<TSync>;
+
+/**
+ * @public
+ */
+export declare type InternalSassOptions = Pick<Options<SyncMode>, "style" | "loadPaths" | "silenceDeprecations">;
+
+/**
+ * @public
+ */
+export declare const LOG_LEVELS: readonly ["verbose", "error", "info", "silent"];
+
+/**
+ * @public
+ */
+export declare type LogLevel = (typeof LOG_LEVELS)[number];
+
+/**
+ * @public
+ */
+declare const main: (pattern: string, cliOptions: Partial<CLIOptions>) => Promise<void>;
+export default main;
+
+/**
+ * @public
+ */
+export declare type QuoteType = "single" | "double";
+
+/**
+ * @public
+ */
+export declare interface SASSImporterOptions {
+    aliases?: Aliases;
+    aliasPrefixes?: Aliases;
+    importers?: Importer[];
+}
+
+/**
+ * @public
+ */
+export declare interface SASSOptions extends SASSImporterOptions, InternalSassOptions {
+    nameFormat?: string | string[];
+    implementation: Implementations;
+    async?: boolean;
+    importers?: Importer<SyncMode>[];
+}
+
+/**
+ * @public
+ */
+export declare type SyncMode = "sync" | "async";
+
+export { }

package/esm/typescript/class-names-to-type-definition.d.ts

@@ -1,6 +1,12 @@
 import type { ClassName } from "../sass/file-to-class-names.js";
+/**
+ * @public
+ */
 export type ExportType = "named" | "default";
 export declare const EXPORT_TYPES: ExportType[];
+/**
+ * @public
+ */
 export type QuoteType = "single" | "double";
 export declare const QUOTE_TYPES: QuoteType[];
 export interface TypeDefinitionOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@najemi-software/typed-scss-modules",
-    "version": "13.3.0",
+    "version": "13.4.0-alpha.52.1",
     "private": false,
     "description": "TypeScript type definition generator for SCSS CSS Modules",
     "keywords": [
@@ -49,7 +49,8 @@
         "access": "public"
     },
     "scripts": {
-        "build": "pnpm run clean && tsgo -p tsconfig.build.json && chmod +x esm/cli.js",
+        "api-extractor": "mkdir -p api && [ -z \"${CI}\" ] && (api-extractor run -l) || (api-extractor run)",
+        "build": "pnpm run clean && tsgo -p tsconfig.build.json && chmod +x esm/cli.js && pnpm run api-extractor",
         "check:types": "tsgo --noEmit",
         "clean": "rm -rf ./esm",
         "format": "oxfmt --check",
@@ -76,6 +77,7 @@
         "yargs": "^17.7.2"
     },
     "devDependencies": {
+        "@microsoft/api-extractor": "^7.55.2",
         "@tsjam/eslint-config-recommended": "^0.2.4",
         "@types/node": "^22.19.3",
         "@types/reserved-words": "^0.1.0",