@plumeria/utils 18.3.18 → 18.4.0

package/dist/index.d.ts

@@ -15,3 +15,5 @@ export type { ReferenceIdentifiers } from './references';
 export { collectReferenceIdentifiers } from './references';
 export { profiling, mark, measure, tally, timed, timedAsync } from './profiler';
 export { DEFAULT_STYLE_PROP } from './constants';
+export type { PropertyPolicy, PropertyPolicyOptions } from './propertyPolicy';
+export { resolvePropertyPolicy, assertPropertyPolicy } from './propertyPolicy';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_STYLE_PROP = exports.timedAsync = exports.timed = exports.tally = exports.measure = exports.mark = exports.profiling = exports.collectReferenceIdentifiers = exports.getLeadingCommentLength = exports.processVariants = exports.optimizer = exports.resolveImportPath = exports.themeHashOf = exports.getStateWeights = exports.getPseudoElement = exports.getSpecificity = exports.getStyleRecords = exports.resolveThemeSelector = exports.resolveComponentKey = exports.resolveExport = exports.getFileDependencies = exports.resolveFileError = exports.scanAll = exports.deepMerge = exports.extractOndemandStyles = exports.getRootIdentifier = exports.t = exports.traverse = exports.collectLocalConsts = exports.objectExpressionToObject = void 0;
+exports.assertPropertyPolicy = exports.resolvePropertyPolicy = exports.DEFAULT_STYLE_PROP = exports.timedAsync = exports.timed = exports.tally = exports.measure = exports.mark = exports.profiling = exports.collectReferenceIdentifiers = exports.getLeadingCommentLength = exports.processVariants = exports.optimizer = exports.resolveImportPath = exports.themeHashOf = exports.getStateWeights = exports.getPseudoElement = exports.getSpecificity = exports.getStyleRecords = exports.resolveThemeSelector = exports.resolveComponentKey = exports.resolveExport = exports.getFileDependencies = exports.resolveFileError = exports.scanAll = exports.deepMerge = exports.extractOndemandStyles = exports.getRootIdentifier = exports.t = exports.traverse = exports.collectLocalConsts = exports.objectExpressionToObject = void 0;
 var parser_1 = require("./parser");
 Object.defineProperty(exports, "objectExpressionToObject", { enumerable: true, get: function () { return parser_1.objectExpressionToObject; } });
 Object.defineProperty(exports, "collectLocalConsts", { enumerable: true, get: function () { return parser_1.collectLocalConsts; } });
@@ -43,3 +43,6 @@ Object.defineProperty(exports, "timed", { enumerable: true, get: function () { r
 Object.defineProperty(exports, "timedAsync", { enumerable: true, get: function () { return profiler_1.timedAsync; } });
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "DEFAULT_STYLE_PROP", { enumerable: true, get: function () { return constants_1.DEFAULT_STYLE_PROP; } });
+var propertyPolicy_1 = require("./propertyPolicy");
+Object.defineProperty(exports, "resolvePropertyPolicy", { enumerable: true, get: function () { return propertyPolicy_1.resolvePropertyPolicy; } });
+Object.defineProperty(exports, "assertPropertyPolicy", { enumerable: true, get: function () { return propertyPolicy_1.assertPropertyPolicy; } });

package/dist/propertyPolicy.d.ts

@@ -0,0 +1,16 @@
+import type { Module } from '@swc/core';
+import type { PropertySpelling } from 'zss-engine';
+export interface PropertyPolicyOptions {
+    withoutLogicalProperties?: boolean | {
+        sizes?: boolean;
+    };
+    withoutPhysicalProperties?: boolean | {
+        sizes?: boolean;
+    };
+}
+export interface PropertyPolicy {
+    reject: PropertySpelling;
+    includeAxes: boolean;
+}
+export declare const resolvePropertyPolicy: (options: PropertyPolicyOptions) => PropertyPolicy | undefined;
+export declare const assertPropertyPolicy: (ast: Module, policy: PropertyPolicy | undefined, resourcePath: string) => void;

package/dist/propertyPolicy.js

@@ -0,0 +1,151 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertPropertyPolicy = exports.resolvePropertyPolicy = void 0;
+const path = __importStar(require("path"));
+const zss_engine_1 = require("zss-engine");
+const parser_1 = require("./parser");
+const STYLE_APIS = ['create', 'keyframes', 'viewTransition'];
+const MESSAGES = {
+    physical: (name, counterpart) => `'${name}' is the physical name of this property. Write it as '${counterpart}', which follows the writing mode.`,
+    logical: (name, counterpart) => `'${name}' is the logical name of this property. This project is written in physical properties; use '${counterpart}'.`,
+};
+const isEnabled = (option) => option === true || (typeof option === 'object' && option !== null);
+const axesOf = (option) => typeof option === 'object' && option !== null
+    ? (option.sizes ?? false)
+    : false;
+const resolvePropertyPolicy = (options) => {
+    const withoutLogical = isEnabled(options.withoutLogicalProperties);
+    const withoutPhysical = isEnabled(options.withoutPhysicalProperties);
+    if (withoutLogical && withoutPhysical)
+        throw new Error(`[plumeria] withoutLogicalProperties and withoutPhysicalProperties contradict each other. Enable only the one this project writes against.`);
+    if (withoutLogical)
+        return {
+            reject: 'logical',
+            includeAxes: axesOf(options.withoutLogicalProperties),
+        };
+    if (withoutPhysical)
+        return {
+            reject: 'physical',
+            includeAxes: axesOf(options.withoutPhysicalProperties),
+        };
+    return undefined;
+};
+exports.resolvePropertyPolicy = resolvePropertyPolicy;
+const assertPropertyPolicy = (ast, policy, resourcePath) => {
+    if (!policy)
+        return;
+    const plumeriaAliases = {};
+    const styleObjectOf = (node) => {
+        if (parser_1.t.isObjectExpression(node))
+            return node;
+        if (parser_1.t.isArrowFunctionExpression(node) || parser_1.t.isFunctionExpression(node)) {
+            const body = node.body;
+            if (parser_1.t.isObjectExpression(body))
+                return body;
+            if (parser_1.t.isParenthesisExpression(body))
+                return styleObjectOf(body.expression);
+        }
+        return undefined;
+    };
+    const nameOf = (key) => {
+        if (parser_1.t.isIdentifier(key) || parser_1.t.isStringLiteral(key))
+            return key.value;
+        return '';
+    };
+    const check = (node) => {
+        node.properties.forEach((prop) => {
+            if (!parser_1.t.isObjectProperty(prop))
+                return;
+            const nested = styleObjectOf(prop.value);
+            if (nested) {
+                check(nested);
+                return;
+            }
+            const name = nameOf(prop.key);
+            if (!name)
+                return;
+            const kebab = (0, zss_engine_1.camelToKebabCase)(name);
+            if ((0, zss_engine_1.spellingOf)(kebab, policy.includeAxes) !== policy.reject)
+                return;
+            const counterpart = (0, zss_engine_1.kebabToCamelCase)((0, zss_engine_1.counterpartOf)(kebab));
+            throw new Error(`[plumeria] ${MESSAGES[policy.reject](name, counterpart)} (${path.basename(resourcePath)})`);
+        });
+    };
+    (0, parser_1.traverse)(ast, {
+        ImportDeclaration({ node }) {
+            if (node.source.value !== '@plumeria/core')
+                return;
+            node.specifiers.forEach((specifier) => {
+                if (specifier.type === 'ImportNamespaceSpecifier' ||
+                    specifier.type === 'ImportDefaultSpecifier') {
+                    plumeriaAliases[specifier.local.value] = 'NAMESPACE';
+                }
+                else if (specifier.type === 'ImportSpecifier') {
+                    plumeriaAliases[specifier.local.value] = specifier.imported
+                        ? specifier.imported.value
+                        : specifier.local.value;
+                }
+            });
+        },
+        CallExpression({ node }) {
+            const callee = node.callee;
+            let apiName;
+            if (parser_1.t.isMemberExpression(callee) &&
+                parser_1.t.isIdentifier(callee.object) &&
+                parser_1.t.isIdentifier(callee.property)) {
+                if (plumeriaAliases[callee.object.value] === 'NAMESPACE')
+                    apiName = callee.property.value;
+            }
+            else if (parser_1.t.isIdentifier(callee)) {
+                apiName = plumeriaAliases[callee.value];
+            }
+            if (!apiName || !STYLE_APIS.includes(apiName))
+                return;
+            node.arguments.forEach(({ expression }) => {
+                if (!parser_1.t.isObjectExpression(expression))
+                    return;
+                expression.properties.forEach((prop) => {
+                    if (!parser_1.t.isObjectProperty(prop))
+                        return;
+                    const style = styleObjectOf(prop.value);
+                    if (style)
+                        check(style);
+                });
+            });
+        },
+    });
+};
+exports.assertPropertyPolicy = assertPropertyPolicy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plumeria/utils",
-  "version": "18.3.18",
+  "version": "18.4.0",
   "description": "Plumeria Utils",
   "author": "Refirst 11",
   "license": "MIT",
@@ -25,7 +25,7 @@
     "@swc/core": "1.15.47",
     "lightningcss": "^1.32.0",
     "postcss": "8.5.26",
-    "zss-engine": "2.7.0"
+    "zss-engine": "2.8.0"
   },
   "publishConfig": {
     "access": "public",