@wp-typia/block-types 0.3.0 → 0.3.2

package/dist/blocks/bindings-settings.d.ts

@@ -0,0 +1,27 @@
+import type { WordPressCompatibilitySettings, WordPressVersion } from "./compatibility.js";
+import type { BindingSourceDefinition, BindingSourceVersionGates, DefineBindingSourceInlineOptions, DefineBindingSourceOptions, StripDefineBindingSourceOptions } from "./bindings-core.js";
+export declare const DEFINE_BINDING_SOURCE_INLINE_OPTION_KEYS: Set<string>;
+export interface ResolvedDefineBindingSourceSettings {
+    readonly compatibility: WordPressCompatibilitySettings;
+    readonly features: {
+        readonly editor: boolean;
+        readonly fieldsList: boolean;
+        readonly metadata: boolean;
+        readonly server: boolean;
+        readonly supportedAttributesFilter: boolean;
+    };
+    readonly gates: BindingSourceVersionGates;
+    readonly logger: DefineBindingSourceOptions["logger"];
+    readonly onDiagnostic: DefineBindingSourceOptions["onDiagnostic"];
+    readonly strict: boolean;
+}
+export declare function isBindingSourceVersionGates(value: WordPressVersion | BindingSourceVersionGates | undefined): value is BindingSourceVersionGates;
+export declare function splitDefineBindingSourceInput<TSource extends BindingSourceDefinition & DefineBindingSourceInlineOptions>(source: TSource): {
+    inlineOptions: DefineBindingSourceInlineOptions;
+    source: StripDefineBindingSourceOptions<TSource> & BindingSourceDefinition;
+};
+export declare function resolveMinWordPress(inlineOptions: DefineBindingSourceInlineOptions, options: DefineBindingSourceOptions): {
+    compatibility: WordPressCompatibilitySettings;
+    gates: BindingSourceVersionGates;
+};
+export declare function resolveDefineBindingSourceSettings(inlineOptions: DefineBindingSourceInlineOptions, options: DefineBindingSourceOptions, source: BindingSourceDefinition): ResolvedDefineBindingSourceSettings;

package/dist/blocks/bindings-settings.js

@@ -0,0 +1,115 @@
+import { isObjectRecord } from "./shared/object-utils.js";
+export const DEFINE_BINDING_SOURCE_INLINE_OPTION_KEYS = new Set([
+    "allowUnknownFutureKeys",
+    "editor",
+    "fieldsList",
+    "logger",
+    "minVersion",
+    "minWordPress",
+    "minWordPressEditor",
+    "minWordPressFieldsList",
+    "minWordPressServer",
+    "minWordPressSupportedAttributesFilter",
+    "onDiagnostic",
+    "server",
+    "strict",
+    "supportedAttributesFilter",
+]);
+export function isBindingSourceVersionGates(value) {
+    return isObjectRecord(value);
+}
+export function splitDefineBindingSourceInput(source) {
+    const inlineOptions = {};
+    const normalizedSource = {};
+    for (const [key, value] of Object.entries(source)) {
+        if (DEFINE_BINDING_SOURCE_INLINE_OPTION_KEYS.has(key)) {
+            Object.assign(inlineOptions, { [key]: value });
+            continue;
+        }
+        normalizedSource[key] = value;
+    }
+    return {
+        inlineOptions,
+        source: normalizedSource,
+    };
+}
+export function resolveMinWordPress(inlineOptions, options) {
+    const optionMinWordPress = options.minWordPress;
+    const inlineMinWordPress = inlineOptions.minWordPress;
+    const optionGates = isBindingSourceVersionGates(optionMinWordPress)
+        ? optionMinWordPress
+        : {};
+    const inlineGates = isBindingSourceVersionGates(inlineMinWordPress)
+        ? inlineMinWordPress
+        : {};
+    const minVersion = options.minVersion ??
+        (typeof optionMinWordPress === "string" ? optionMinWordPress : undefined) ??
+        inlineOptions.minVersion ??
+        (typeof inlineMinWordPress === "string" ? inlineMinWordPress : undefined);
+    const compatibility = {
+        strict: options.strict ?? inlineOptions.strict ?? true,
+    };
+    if (options.allowUnknownFutureKeys ?? inlineOptions.allowUnknownFutureKeys) {
+        Object.assign(compatibility, {
+            allowUnknownFutureKeys: options.allowUnknownFutureKeys ?? inlineOptions.allowUnknownFutureKeys,
+        });
+    }
+    if (minVersion !== undefined) {
+        Object.assign(compatibility, { minVersion });
+    }
+    const gates = {};
+    const editor = options.minWordPressEditor ??
+        optionGates.editor ??
+        inlineOptions.minWordPressEditor ??
+        inlineGates.editor;
+    const fieldsList = options.minWordPressFieldsList ??
+        optionGates.fieldsList ??
+        inlineOptions.minWordPressFieldsList ??
+        inlineGates.fieldsList;
+    const server = options.minWordPressServer ??
+        optionGates.server ??
+        inlineOptions.minWordPressServer ??
+        inlineGates.server;
+    const supportedAttributesFilter = options.minWordPressSupportedAttributesFilter ??
+        optionGates.supportedAttributesFilter ??
+        inlineOptions.minWordPressSupportedAttributesFilter ??
+        inlineGates.supportedAttributesFilter;
+    if (editor !== undefined) {
+        Object.assign(gates, { editor });
+    }
+    if (fieldsList !== undefined) {
+        Object.assign(gates, { fieldsList });
+    }
+    if (server !== undefined) {
+        Object.assign(gates, { server });
+    }
+    if (supportedAttributesFilter !== undefined) {
+        Object.assign(gates, { supportedAttributesFilter });
+    }
+    return {
+        compatibility,
+        gates,
+    };
+}
+export function resolveDefineBindingSourceSettings(inlineOptions, options, source) {
+    const { compatibility, gates } = resolveMinWordPress(inlineOptions, options);
+    const strict = compatibility.strict ?? true;
+    const hasFields = (source.fields?.length ?? 0) > 0;
+    const hasBindableAttributes = (source.bindableAttributes?.length ?? 0) > 0;
+    return {
+        compatibility,
+        features: {
+            editor: options.editor ?? inlineOptions.editor ?? true,
+            fieldsList: options.fieldsList ?? inlineOptions.fieldsList ?? hasFields,
+            metadata: true,
+            server: options.server ?? inlineOptions.server ?? true,
+            supportedAttributesFilter: options.supportedAttributesFilter ??
+                inlineOptions.supportedAttributesFilter ??
+                hasBindableAttributes,
+        },
+        gates,
+        logger: options.logger ?? inlineOptions.logger,
+        onDiagnostic: options.onDiagnostic ?? inlineOptions.onDiagnostic,
+        strict,
+    };
+}

package/dist/blocks/bindings.d.ts

@@ -1,132 +1,2 @@
-import type { BlockAttributes } from "./registration.js";
-import { type WordPressBlockApiCompatibilityDiagnostic, type WordPressBlockApiCompatibilityFeature, type WordPressBlockApiCompatibilityManifest, type WordPressCompatibilitySettings, type WordPressVersion } from "./compatibility.js";
-export type BindingSourceName = `${string}/${string}`;
-export type BindingSourceArgs = Readonly<Record<string, unknown>>;
-export type BindingFieldType = "array" | "boolean" | "integer" | "number" | "object" | "string";
-export interface BindingSourceField<TArgs extends BindingSourceArgs = BindingSourceArgs> {
-    readonly args?: TArgs;
-    readonly label: string;
-    readonly name: string;
-    readonly type?: BindingFieldType;
-}
-export type BlockBindingAttributeName<TAttributes extends BlockAttributes = BlockAttributes> = Extract<Exclude<keyof TAttributes, "metadata">, string>;
-export interface BindingSourceBindableAttributes<TAttributes extends BlockAttributes = BlockAttributes, TBlockName extends string = string, TAttributesList extends readonly BlockBindingAttributeName<TAttributes>[] = readonly BlockBindingAttributeName<TAttributes>[]> {
-    readonly attributes: TAttributesList;
-    readonly blockName: TBlockName;
-}
-export interface BindingSourceDefinition<TName extends string = string, TArgs extends BindingSourceArgs = BindingSourceArgs, TFields extends readonly BindingSourceField[] = readonly BindingSourceField[]> {
-    readonly args?: TArgs;
-    readonly bindableAttributes?: readonly BindingSourceBindableAttributes[];
-    readonly fields?: TFields;
-    readonly getValueCallback?: string;
-    readonly label?: string;
-    readonly name: TName;
-    readonly usesContext?: readonly string[];
-}
-export interface BindingSourceVersionGates {
-    readonly editor?: WordPressVersion;
-    readonly fieldsList?: WordPressVersion;
-    readonly server?: WordPressVersion;
-    readonly supportedAttributesFilter?: WordPressVersion;
-}
-export interface DefineBindingSourceInlineOptions {
-    readonly allowUnknownFutureKeys?: boolean;
-    readonly editor?: boolean;
-    readonly fieldsList?: boolean;
-    readonly minVersion?: WordPressVersion;
-    readonly minWordPress?: WordPressVersion | BindingSourceVersionGates;
-    readonly minWordPressEditor?: WordPressVersion;
-    readonly minWordPressFieldsList?: WordPressVersion;
-    readonly minWordPressServer?: WordPressVersion;
-    readonly minWordPressSupportedAttributesFilter?: WordPressVersion;
-    readonly onDiagnostic?: (diagnostic: BindingSourceDiagnostic) => void;
-    readonly server?: boolean;
-    readonly strict?: boolean;
-    readonly supportedAttributesFilter?: boolean;
-}
-export interface DefineBindingSourceOptions extends WordPressCompatibilitySettings {
-    readonly editor?: boolean;
-    readonly fieldsList?: boolean;
-    readonly minWordPress?: WordPressVersion | BindingSourceVersionGates;
-    readonly minWordPressEditor?: WordPressVersion;
-    readonly minWordPressFieldsList?: WordPressVersion;
-    readonly minWordPressServer?: WordPressVersion;
-    readonly minWordPressSupportedAttributesFilter?: WordPressVersion;
-    readonly onDiagnostic?: (diagnostic: BindingSourceDiagnostic) => void;
-    readonly server?: boolean;
-    readonly supportedAttributesFilter?: boolean;
-}
-export type StripDefineBindingSourceOptions<TSource> = Omit<TSource, keyof DefineBindingSourceInlineOptions>;
-export declare const DEFINED_BLOCK_BINDING_SOURCE_METADATA: unique symbol;
-export type DefinedBlockBindingSourceMetadataKey = typeof DEFINED_BLOCK_BINDING_SOURCE_METADATA;
-export interface DefinedBlockBindingSourceMetadata {
-    readonly diagnostics: readonly BindingSourceDiagnostic[];
-    readonly features: readonly WordPressBlockApiCompatibilityFeature[];
-    readonly manifest: WordPressBlockApiCompatibilityManifest;
-}
-export type DefinedBindingSource<TName extends string = string, TArgs extends BindingSourceArgs = BindingSourceArgs, TFields extends readonly BindingSourceField[] = readonly BindingSourceField[], TSource extends BindingSourceDefinition = BindingSourceDefinition> = Readonly<StripDefineBindingSourceOptions<TSource>> & {
-    readonly [DEFINED_BLOCK_BINDING_SOURCE_METADATA]?: DefinedBlockBindingSourceMetadata | undefined;
-    readonly __wpTypiaBindingSourceArgs?: TArgs;
-    readonly __wpTypiaBindingSourceFields?: TFields;
-    readonly name: TName;
-};
-export interface BlockBinding<TSourceName extends string = string, TArgs extends BindingSourceArgs = BindingSourceArgs> {
-    readonly args?: TArgs;
-    readonly source: TSourceName;
-}
-type BindingSourceInferredArgs<TSource> = TSource extends {
-    readonly __wpTypiaBindingSourceArgs?: infer TArgs extends BindingSourceArgs;
-} ? TArgs : BindingSourceArgs;
-export type Binding<TSource extends DefinedBindingSource | string, TArgs extends BindingSourceArgs = BindingSourceInferredArgs<TSource>> = TSource extends DefinedBindingSource<infer TName, infer TSourceArgs> ? TArgs extends TSourceArgs ? BlockBinding<TName, TArgs> : never : TSource extends string ? BlockBinding<TSource, TArgs> : never;
-export type BlockBindingMap<TAttributes extends BlockAttributes = BlockAttributes> = Readonly<Partial<Record<BlockBindingAttributeName<TAttributes>, BlockBinding>>>;
-export interface BlockMetadataBindings<TBindings extends Readonly<Record<string, BlockBinding | undefined>> = Readonly<Record<string, BlockBinding>>> {
-    readonly bindings?: TBindings;
-}
-export type TypedBlockMetadataBindings<TAttributes extends BlockAttributes, TBindings extends BlockBindingMap<TAttributes> = BlockBindingMap<TAttributes>> = BlockMetadataBindings<TBindings>;
-export type BindingSourceDiagnosticCode = "duplicate-bindable-attribute" | "duplicate-field-name" | "fields-list-requires-editor" | "invalid-bindable-attribute" | "invalid-block-name" | "invalid-field-name" | "invalid-source-name" | "missing-php-callback";
-export interface BindingSourceAuthoringDiagnostic {
-    readonly attribute?: string | undefined;
-    readonly blockName?: string | undefined;
-    readonly code: BindingSourceDiagnosticCode;
-    readonly fieldName?: string | undefined;
-    readonly message: string;
-    readonly severity: "error" | "warning";
-    readonly sourceName: string;
-}
-export type BindingSourceDiagnostic = BindingSourceAuthoringDiagnostic | WordPressBlockApiCompatibilityDiagnostic;
-export interface BindingSourceRegistrationEntry {
-    readonly metadata: DefinedBlockBindingSourceMetadata;
-    readonly source: DefinedBindingSource;
-}
-export interface CreatePhpBindingSourceRegistrationSourceOptions {
-    readonly functionName?: string;
-    readonly hook?: string;
-    readonly includeOpeningTag?: boolean;
-    readonly textDomain?: string;
-}
-export interface CreateEditorBindingSourceRegistrationSourceOptions {
-    readonly functionName?: string;
-    readonly importSource?: string;
-}
-export declare function collectBindingSourceCompatibilityFeatures(settings?: {
-    readonly editor?: boolean;
-    readonly fieldsList?: boolean;
-    readonly metadata?: boolean;
-    readonly server?: boolean;
-    readonly supportedAttributesFilter?: boolean;
-}): readonly WordPressBlockApiCompatibilityFeature[];
-export declare function createBindingSourceCompatibilityManifest(settings?: DefineBindingSourceOptions): WordPressBlockApiCompatibilityManifest;
-export declare function getDefinedBindingSourceMetadata(source: unknown): DefinedBlockBindingSourceMetadata | undefined;
-export declare function getDefinedBindingSourceCompatibilityManifest(source: unknown): WordPressBlockApiCompatibilityManifest | undefined;
-export declare function defineBindingSource<const TSource extends BindingSourceDefinition & DefineBindingSourceInlineOptions>(source: TSource, options?: DefineBindingSourceOptions): DefinedBindingSource<Extract<TSource["name"], string>, TSource extends {
-    readonly args: infer TArgs extends BindingSourceArgs;
-} ? TArgs : BindingSourceArgs, TSource extends {
-    readonly fields: infer TFields extends readonly BindingSourceField[];
-} ? TFields : readonly BindingSourceField[], TSource>;
-export declare function defineBindableAttributes<TAttributes extends BlockAttributes = BlockAttributes, const TBlockName extends string = string, const TAttributesList extends readonly BlockBindingAttributeName<TAttributes>[] = readonly BlockBindingAttributeName<TAttributes>[]>(blockName: TBlockName, attributes: TAttributesList): BindingSourceBindableAttributes<TAttributes, TBlockName, TAttributesList>;
-export declare function defineBlockMetadataBindings<const TBindings extends Readonly<Record<string, BlockBinding | undefined>>>(bindings: TBindings): BlockMetadataBindings<TBindings>;
-export declare function defineTypedBlockMetadataBindings<TAttributes extends BlockAttributes, const TBindings extends BlockBindingMap<TAttributes> = BlockBindingMap<TAttributes>>(bindings: TBindings): TypedBlockMetadataBindings<TAttributes, TBindings>;
-export declare function createBindingSourceRegistrationPlan(sources: readonly DefinedBindingSource[]): readonly BindingSourceRegistrationEntry[];
-export declare function createPhpBindingSourceRegistrationSource(sources: DefinedBindingSource | readonly DefinedBindingSource[], options?: CreatePhpBindingSourceRegistrationSourceOptions): string;
-export declare function createEditorBindingSourceRegistrationSource(sources: DefinedBindingSource | readonly DefinedBindingSource[], options?: CreateEditorBindingSourceRegistrationSourceOptions): string;
-export {};
+export * from "./bindings-core.js";
+export * from "./bindings-codegen.js";