@cichol/sass-bridge 4.3.0 → 4.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cichol/sass-bridge",
-    "version": "4.3.0",
+    "version": "4.3.1",
     "description": "A bridge interface to define Sass custom functions.",
     "homepage": "https://github.com/morrighan/packages",
     "bugs": {

package/types/index.d.ts

@@ -0,0 +1,13 @@
+import 'reflect-metadata';
+import { CustomFunction } from 'sass';
+import type { JavaScriptType } from './types';
+export interface BridgedFunction {
+    execute(): JavaScriptType | Promise<JavaScriptType>;
+}
+export interface Constructor {
+    new (...args: JavaScriptType[]): BridgedFunction;
+}
+export declare function sassFunction(definition: string): ClassDecorator;
+export declare function getFunctions(...moduleImports: Promise<{
+    default: Constructor;
+}>[]): Promise<Record<string, CustomFunction<'async'>>>;

package/types/type-converter.d.ts

@@ -0,0 +1,3 @@
+import { type SassType, type JavaScriptType } from './types';
+export declare function sassToJavaScriptType(sassValue: SassType): JavaScriptType;
+export declare function javaScriptToSassType(rawValue: JavaScriptType): SassType;

package/types/types.d.ts

@@ -0,0 +1,31 @@
+import type { Color } from 'chroma-js';
+import * as sass from 'sass';
+export type Primitives = boolean | number | string;
+export type NumberWithUnit = {
+    value: number;
+    unit: string;
+};
+export type JavaScriptType<Base = Primitives | Color | NumberWithUnit | null> = Base | JavaScriptType<Base>[] | Map<JavaScriptType<Base>, JavaScriptType<Base>>;
+type FilterSassPrefix<T extends string> = T extends `Sass${infer R}` ? R : never;
+type SassTypes = Exclude<`Sass${FilterSassPrefix<keyof typeof sass>}`, `Sass${'Boolean' | 'Calculation'}`>;
+declare const SassTypes: { [P in SassTypes]: (typeof sass)[P]; };
+export declare const SassTRUE: sass.SassBoolean;
+export type SassTRUE = typeof SassTRUE;
+export declare const SassFALSE: sass.SassBoolean;
+export type SassFALSE = typeof SassFALSE;
+export declare const SassNULL: sass.Value;
+export type SassNULL = typeof SassNULL;
+export declare const SassNumber: typeof sass.SassNumber;
+export type SassNumber = InstanceType<typeof SassNumber>;
+export declare const SassString: typeof sass.SassString;
+export type SassString = InstanceType<typeof SassString>;
+export declare const SassColor: typeof sass.SassColor;
+export type SassColor = InstanceType<typeof SassColor>;
+export declare const SassList: typeof sass.SassList;
+export type SassList = InstanceType<typeof SassList>;
+export declare const SassMap: typeof sass.SassMap;
+export type SassMap = InstanceType<typeof SassMap>;
+export declare const SassBoolean: typeof sass.SassBoolean;
+export type SassBoolean = sass.SassBoolean;
+export type SassType = InstanceType<typeof SassTypes extends Record<any, infer R> ? R : never> | SassBoolean;
+export {};

package/tests/artifacts/custom-function.ts

@@ -1,18 +0,0 @@
-import type { BridgedFunction } from '../../types';
-import { sassFunction } from '../../releases/esm.js'; // eslint-disable-line import/extensions
-
-@sassFunction('custom-function($a, $b)')
-export default class CustomFunction implements BridgedFunction {
-    #a: string;
-
-    #b: string;
-
-    public constructor(A: string, B: string) {
-        this.#a = A;
-        this.#b = B;
-    }
-
-    public async execute() {
-        return this.#a.toLowerCase() + this.#b.toUpperCase();
-    }
-}

package/tests/artifacts/sqrt-cos.ts

@@ -1,15 +0,0 @@
-import type { BridgedFunction } from '../../types';
-import { sassFunction } from '../../releases/esm.js'; // eslint-disable-line import/extensions
-
-@sassFunction('sqrt-cos($x)')
-export default class SquareRootCosine implements BridgedFunction {
-    #x: number;
-
-    public constructor(X: number) {
-        this.#x = X;
-    }
-
-    public async execute() {
-        return Math.sqrt(Math.cos(this.#x));
-    }
-}

package/tests/index.ts

@@ -1,31 +0,0 @@
-// eslint-disable-next-line eslint-comments/disable-enable-pair
-/* eslint-disable import/extensions */
-
-// Third-party modules.
-import { describe, it } from 'mocha';
-import { expect } from 'chai';
-import * as sass from 'sass';
-
-// Testing target.
-import { getFunctions } from '../releases/esm.js';
-
-describe('@cichol/sass-bridge', () => {
-    it('should be working properly', async () => {
-        const source = `
-            body > *:first-child:after {
-                content: custom-function('HELLO', 'world');
-                line-height: sqrt-cos(${2 * Math.PI});
-            }
-        `;
-
-        const functions = await getFunctions(
-            import('./artifacts/custom-function.ts'),
-            import('./artifacts/sqrt-cos.ts')
-        );
-
-        const { css: result } = await sass.compileStringAsync(source, { functions });
-
-        expect(result).to.includes('content: "helloWORLD";');
-        expect(result).to.includes('line-height: 1;');
-    });
-});